Budget Calculator

This project is a web-based budget calculator that allows users to register, log in, input budget details, view tables, and graphical representations of their budgets, as well as amend user details.

link to backend - https://github.com/Phil-bro-92/budget-calculator-be

Features

• User Authentication: Users can register and log in securely to access their budget details.
• Budget Input: Users can input their budget details, including income, expenses, categories, etc.
• Table View: View a table representation of the budget details.
• Graphical Representation: Visualize budget data through graphs and charts for better understanding.
• User Profile Management: Users can amend their details through the profile section.

Technologies Used

• Frontend: HTML, SCSS, JavaScript (React)
• Backend: Node.js/Express
• Database: MongoDB
• Authentication: JWT (JSON Web Tokens)

Installation

1. Clone the FE repository:

   git clone https://github.com/Phil-bro-92/budget-calculator-fe.git

2. Install FE dependencies

   cd budget-calculator-FE
   npm install # or yarn install

3. Clone the BE repository:

   git clone https://github.com/Phil-bro-92/budget-calculator-be.git  ```

4. Install BE dependencies

   cd budget-calculator-BE
   npm install # or yarn install

5. Start the applications on FE & BE:

   npm start # or yarn start

Usage

• Register a new account or log in with existing credentials.
• Input your budget details in the provided sections.
• View your budget data in tables and graphical representations.
• Navigate to the profile section to manage your user details.

Contributing

Contributions are welcome! If you want to contribute to this project, follow these steps:

• Fork this repository.
• Create a new branch (git checkout -b feature/your-feature).
• Make modifications and commit changes (git commit -am 'Add your feature').
• Push to the branch (git push origin feature/your-feature).
• Create a pull request.

License

This project is licensed under the [MIT License].