An open API service indexing awesome lists of open source software.

https://github.com/gbowne1/savvybudget

A React 18.2 and MUI 5.11 Budget, Expense, Bill Tracker for the home
https://github.com/gbowne1/savvybudget

bills budget budgeting expenses household personal tracking

Last synced: 12 days ago
JSON representation

A React 18.2 and MUI 5.11 Budget, Expense, Bill Tracker for the home

Awesome Lists containing this project

README

        

# SavvyBudget

A budget, expenses, and bill tracking application for non-commercial home and personal use.

## Technologies Used

This app is made with:

[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-336791?style=for-the-badge&logo=postgresql&logoColor=white)](https://www.postgresql.org/)
[![Express](https://img.shields.io/badge/Express.js-404D59?style=for-the-badge)](https://expressjs.com)
[![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)](https://react.dev/)
[![NodeJS](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)](https://www.nodejs.com)
[![MaterialUI](https://img.shields.io/badge/Material--UI-0081CB?style=for-the-badge&logo=material-ui&logoColor=white)](https://www.mui.com)

Bootstrapped with Create-React-App v5 aka react-scripts

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Installation

1. Clone the repository:
```bash
git clone https://github.com/gbowne1/SavvyBudget.git
```
2. Navigate to the project directory:
```bash
cd SavvyBudget
```
3. Install dependencies:
```bash
npm install
```
4. Start the development server:
```bash
npm start
```

## Usage

We recommend using this with Node 18.15.0 or at the bare minimum the latest LTS.

You should already be familiar with React 17 and/or 18, JavaScript ES5/ES6/ES7, and JSX.

Please note that this project is not hosted anywhere yet, and the backend is currently under construction. Use the Create React App development server by running `npm start` inside the root of the project.

## Contributing

If you would like to contribute to this repository, please read our [Contributing](https://github.com/gbowne1/SavvyBudget/blob/main/CONTRIBUTING.md) document. We welcome your pull requests here.

If you would like something to work on, there are plenty of TODOs here:

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.