Budget Tracker

A travel budget tracker progressive web application (PWA) with offline functionality.

Project Links

Repo Link
NOTE: The deployed app can be found on Heroku. Please see the Getting Started section for more information regarding installation, usage, contribution guidelines, and where to go for questions.

Table of Contents

1. About The Project
2. Project Links
3. Demo
4. Getting Started
5. Installation
6. Usage
7. Contribution Guidelines
8. Questions
9. Project Status
10. License

About The Project

The scope of this project was to create a progressive web application (PWA) which provides users a simple way to manage finances while planning for a vacation. This application is to be functional regardless of whether they have internet connectivity.

Users are able to add deposits and expenses to the budget in a clean and simple interface which renders across a variety of devices online or offline. Users can choose to install the app onto their device see Demo below which then places an icon on their device.

Functionality of the application includes:

• Offline functionality
  • Enter deposits and expenses offline
• Once online, offline entries are added to the budget tracker

Because this application cannot be deployed on GitHub, a walkthrough video demonstrates its functionality below. The deployed app can be found on Heroku.

Demo

The following is an overview of the application in operation and rendering of the budget tracker app.

The following is a screenshot of the application and overview of its functionality:

Getting Started

Technologies used in this project include:

• MongoDB
• MongoDB Atlas for deploying to Heroku
• Mongoose
• Node
• Express
• Server-lite
• Compression
• Morgan

Installation:

Clone Repository

• git clone https://github.com/onomatopoetica/budget-tracker.git

Install Dependencies

• All NPM packages required for this application (Express, Compression, Mongoose, Lite-Server and Morgan) are already listed as dependencies in the package.json file. Run the command 'npm i' command in your terminal at the root directory level to install the packages.

• Ensure you have Node.js installed on your machine. The budget tracker application will be invoked by entering node server.js in the command line.

Start Application

• You will see App running on port 3000! in the console. You can then view the app on http://localhost:3000/.

Return to Table of Contents

Usage

• See About The Project or Demo video above for more information on how it works.
• View Project Links above for the link to the deployed app on Heroku.

Contribution Guidelines

• When contributing to this repository, please contact the project team for review of your contribution plan. See contact details below.

Questions

Connect With Me:

Onomatopoetica

Contact

[email protected]

Project Status

Current Project Activity

Active

Return to Table of Contents

License

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

This README was generated with ♥️  by Good README Generator.