PWA Budget Tracker 📈

Description

A PWA Budget Tracker application that allows for offline access and functionality.

• The user will be able to add expenses and deposits to their budget with or without a connection.
• When entering transactions offline, offline-entries will be added to tracker when brought back online.

Built With

Table of Contents

• Description
• Project URL
• Deployment
• Demo/Screenshots
• Installation
• Usage
• Credits
• License
• Resources
• Contact
• Author

Project URL

https://github.com/johnsonr84/pwa-budget-tracker

Deployment

https://amazing-budget-tracker.herokuapp.com/

Mock-Up

pwa-budget-tracker example

Technologies

PWA (Manifest, ServiceWorker), Mongodb, Mongoose, IndexDB Storage, Node.js, Javascript, HTML5, CSS3 

Installation

Access to GitHub.com and a code editor such as vscode is necessary. Click the GitHub link provided above to the APP REPO. Click on the green button that says Clone or Download and Choose how you would like to download: using the SSH/HTTPS keys or download the zip file. If using SSH/HTTPS Key: You will copy the link shown and open up either terminal (mac: pre-installed) or gitbash (pc: must be installed). Once the application is open, you will type git clone paste url here. If using Download ZIP: Click on Download Zip. Locate the file and double click it to unzip the file. Locate the unzipped folder and open it.

Usage

In order to use this APP, you need terminal (mac: pre-installed) or gitbash (pc: must be installed). You also need to download and install node.js and npm or yarn package manager. Open the cloned REPO in your favorite code editor, and then in terminal, enter the command “npm i“ or “yarn add” to install the dependencies. You will also need to signup for a free account at mongodb.com. In addition, make sure to create a .env file on the project root, and input your own mongodb Atals config information (see .env_example for samples). You also need to obtain a Google Book API Key link here and replace process.env.REACT_APP_BOOK_API_KEY in src/Search/Search.js file with you own API KEY. Now you are ready to start using the app by entering “npm start” on your terminal or gitbash. If you just want to try how the app works, you can go to the link here

Credits

Me, myself and Irene

License

This project is mit licensed.

Features

Coming soon maybe

Tests

npm test

Resources

• Choose a License
• Badmath
• shields.io
• w3schools
• stackoverflow.com
• YouTube
• Google
• IndexDB
• 18-PWA-Activities/
• Deployment Guide
• Heroku
• Heroku and MongoDB Atlas.

Contact

Email: robertcjohnson1984@gmail.com

Author

Author(s): Rob Johnson

GitHub: https://github.com/johnsonr84/