Gem Budgeting App

Expense manager to help budget your life!
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Many individuals can struggle to maintain a budget or create a new one from scratch. This app was created with the idea to help all develop a budget plan that adapts to their lifestyles.

Of course, no app is 100% complete and bug free. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people that have and will contribute to this app!

This app is meant to provide users an expense dashboard that allocates their income and fixed costs and creates a plan that the user can follow to stay on top of their budget. (TODO: add more details if needed)

(back to top)

Built With

(back to top)

Getting Started (TODO: UPDATE SECTION)

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/jamih/Gem_Budgeting_App.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = "ENTER YOUR API";

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

Initial build:

• Brainstorm page design in Figma

  • UI Dashboard

  • Expense totals for the month

  • Remaining balance for the month

  • Visual Chart/Diagram of all labeled expenses (Date, Amount, Category (Rent, Grocery, Gas, etc), ???)

  • Button to add expense and redirect to Expense Page

  • Button to export dashboard into formatted Excel Spreadsheet

  • ???

  • UI Add Income and Expenses Page (Can be split in pieces if needed)

  • Inputs for Expenses (option to add multiple)

  • Input for Budget/Income

  • ???

  • UI User Account

  • Account Creation Page

  • Login Page

  • Account Details Page

  • DB setup

• [ ] CRUD Functionality

• [ ] Export functionality for Excel

• [ ] Plan to extend budget to use calender system based on repeating monthly income and monthly expenses to plan for future budgets

• [ ] ???

• [ ] Host on Public Server

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Jami Huang - @twitter_handle1 - email@email_client.com

Cristian Ruiz - @twitter_handle2 - email@email_client.com

Project Link: https://github.com/jamih/Gem_Budgeting_App

(back to top)

Acknowledgments

• Chád Darby's Spring Course
• onthneildrew's README Template
• []()

(back to top)