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

https://github.com/blase147/budget_app

This is a mobile web application that allows users to manage their budget. User can see a list of expenses associated with a group and total amount. It also allows users to introduce new groups/expenses an keep a track of money spent.
https://github.com/blase147/budget_app

javascript rails rails-api rails-application ror ruby ruby-on-rails

Last synced: 5 months ago
JSON representation

This is a mobile web application that allows users to manage their budget. User can see a list of expenses associated with a group and total amount. It also allows users to introduce new groups/expenses an keep a track of money spent.

Awesome Lists containing this project

README

          

![](https://img.shields.io/badge/Microverse-blueviolet)

# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Budget App ](#-budget-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage ](#usage-)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Budget App
This is a mobile web application where you can manage your budget: you have a list of expenses associated with a group, so that you can see how much money you spent and on what. The app allows users to:

- *Register and log in, so that the data is private to them.*
- *Introduce new expenses associated with a group.*
- *See the money spent on each group.*

## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

- **Groups Page:** *Displays a list of groups with their name, icon and total amount of expenses*
- **Expenses page:** *Displays a list of expenses for a given group, ordered by the most recent.*

(back to top)

## 🚀 Live Demo

- [Budget App](https://budget-app-5uzz.onrender.com/)

(back to top)

## 💻 Getting Started

### Prerequisites

In order to run this project you need:
- [Ruby on Rails](https://rubyonrails.org/) installed and running. To get more information, read the [installation guide](https://guides.rubyonrails.org/).

- [PostgreSQL](https://www.postgresql.org/) installed and running
### Setup

Clone this repository to your desired folder:

```
git clone git@github.com:blase147/budget_app.git
cd Budget-App
bundle install
rails db:create
rails db:migrate
```

### Install

Install thr project dependencies with:

```
bundle install
```

### Usage

To run the project, execute the following command:

```
rails server/rails s
```

### Run tests

To run all tests, including unit and integration tests, run the following command:

```
rspec
```

### Deployment

You can deploy this project using:

```
N/A
```

(back to top)

- ## 👥 Author

👤 **Chukwuma Paul Mosanya**

- [GitHub](https://github.com/blase147)
- [Twitter](https://twitter.com/ChukwumaMosanya)
- [LinkedIn](https://www.linkedin.com/in/chukwuma-mosanya)

(back to top)

## 🔭 Future Features

- Add pagination
- Update styles

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/blase147/budget_app/issues).

(back to top)

## ⭐️ Show your support

If you like this project and want to support me make cooler projects Give this project a Star.

(back to top)

## 🙏 Acknowledgments

Original design idea by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella)

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)