/budgeteer

Primary LanguageJavaScript

Budgeteer

License: MIT

Description

Budgeteer is a budget-tracking app that uses MongoDB to store a user's transaction history and IndexedDB and a service worker to enable offline PWA functionality.

Table of Contents

Installation

Download the source files with git clone <url>. Run npm i to install all dependencies. Then create an .env file in the root directory with a MONGODB_URI key pointing to your own MongoDB database.

Usage

To start the localhost server on port 3001, run node server or npm run start. A live demonstration of the app can be viewed on Heroku here.

Screenshot

License

The MIT License

Copyright © 2022 branjames117

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributing

This repository and its contributors follow the Contributor Covenant Code of Conduct.

Questions

This repository was created and is maintained by branjames117.

With any questions email the repository owner at branjames117@gmail.com.