README.md

BillyApp

BillyApp is a mobile application designed to help users manage their monthly bills. The app allows users to add different bills, assign payment dates, track the start of contracts, and calculate the total amount paid over time. It also includes features to notify users of upcoming payments.

Table of Contents

• Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Build and Deployment
• CI/CD Pipeline
• Contributing
• License

Features

• Add and manage multiple bills.
• Assign payment dates and start dates for contracts.
• Calculate total amount paid since the start of each contract.
• Track days left until the next payment.
• Push notifications for upcoming payments (coming soon).

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js & npm: Install from Node.js.
• React via yarn: Install:

  yarn install

• Xcode (for iOS development): Requires macOS.
• Android Studio (for Android development): Includes Android SDK.

Installation

1. Clone the repository:

   git clone https://github.com/majdkt/BillyApp.git
   cd BillyApp

2. Install dependencies:

   yarn install

Usage

1. Start the React app:

   yarn start

Contributing

Contributions are welcome! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes and commit them (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature-branch).
5. Open a pull request.