Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/torobucci/budget_app

Budget_App is a ruby on rails application that allow users to budget their money effectively. It utilizes devise gem for proper user authentication. User can add a category and see expenses on that category.
https://github.com/torobucci/budget_app

devise postgresql rails ruby

Last synced: 26 days ago
JSON representation

Budget_App is a ruby on rails application that allow users to budget their money effectively. It utilizes devise gem for proper user authentication. User can add a category and see expenses on that category.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 Budget Buddy](#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)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 **Budget Buddy**
A simple mobile web application where you can manage your budget: you have a list of expenses associated with a category so that you can see how much money you spent and on what.

Here is the link to a video presentation of the app: [BudgetBuddy](https://www.loom.com/share/c1f474daece74db2a043d6b21a90eabc?sid=04187d29-5921-41b3-b329-3bb9eceaaf61)

## 🛠 Built With

### Tech Stack

### Key Features

- **Register and login**
- **Category List (Home page)**
- **Payments List for a category (Payments page)**
- **Add Payment (Payments page)**
- **Add Category (Categories page)**

(back to top)

## 🚀 Live Demo

- [BudgetBuddy Live Demo](https://budgetbuddy-xwce.onrender.com)

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

### Setup

Clone this repository to your desired folder:


  • cd my-folder


  • Clone this Repository to your desired folder.

### Install

Install this project with:


  • bundle install

### Usage

To run the project, execute the following command:


  • rails server

### Run tests

To run tests, run the following command:

```sh
rubocop -a
```
```sh
npx stylelint "**/*.{css,scss}"
```
```sh
rspec .
```

(back to top)

## 👥 Authors

👤 **Kevin Toro**
- GitHub: [@torobucii](https://github.com/torobucci)
- Twitter: [@torobucii](https://twitter.com/@torobucii)
- LinkedIn: [Kevin Toro](https://www.linkedin.com/in/kevin-toro-047181238/)

## 🔭 Future Features

- Desktop version of the app
- Implement menu toggle button
- Improve dispay of messages
- Improve styling of the project

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project give this repo a star and reach out on our social media, and we will be happy to know about it! 😃

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for this project and [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) for the original design idea.

(back to top)

## 📝 License

This project is [MIT](https://github.com/torobucci/My-Portfolio/blob/main/MIT-LICENSE.txt) licensed.

(back to top)