JoelDore / progressive-budget

📈 PWA for accessing and updating budget information on or offline

Budget PWA

PWA for accessing and updating budget information on or offline

Table of Contents

• Features
• Installation
• Usage
• Download App
• Technologies
• Contributing
• Future Scope
• Questions

Features

• Current total is displayed in green on top of page and changes to red if budget is exceeded (total is negative)
• Add/subtract funds with click of a button
• Transaction history is displayed in a table as well as a graph
• Able to add transactions offline - any offline transactions are stored in browser's indexedDB & automatically posted to database once reconnected

Installation

1. Download project by clicking at the top of this repository, and open project directory in terminal.
2. Install npm packages: express mongoose morgan compression

   npm i
   

Usage

Currently deployed with Heroku

1. Begin by setting a total budget amount and hitting Add Funds

2. Enter a name and dollar amount for a new transaction.

3. Add or subtract amount using corresponding buttons.

4. Transaction will be automatically populated in table and graph below.

   

Download as an app on your mobile device

Android:

1. Open https://jd-budget.herokuapp.com/ in Chrome
2. Tap the three-dot button on the top right
3. Select Add to Home Screen from the menu
4. Customize the app name if desired
5. Open the app that appeared on your home screen

iOS:

1. Open https://jd-budget.herokuapp.com/ in Safari

2. Tap the Share button in URL bar

3. Select Add to Home Screen from the menu

4. Customize the app name if desired

5. Open the app that appeared on your home screen

   

Technologies Used

• Express
• MongoDB/Mongoose
• Morgan
• Compression
• Service Worker
• IndexedDB

Contributing

Contributions welcome!

1. Fork this repository
2. Create a new branch
3. Commit/push your changes
4. Create a new pull request

Future Scope

• Incorporate login system
• Webpack config

Questions

If you have any questions, feel free to create an Issue or contact me directly at [e-mail]

License

This project is MIT licensed.
© 2021 Joel Dore

---