https://github.com/luffytaro22/budget-app

The Budget App is a mobile web application build on Ruby on Rails where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.
https://github.com/luffytaro22/budget-app

mvc-architecture postgresql ruby ruby-on-rails

Last synced: about 1 month ago
JSON representation

The Budget App is a mobile web application build on Ruby on Rails where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.

• Host: GitHub
• URL: https://github.com/luffytaro22/budget-app
• Owner: Luffytaro22
• License: mit
• Created: 2023-10-16T14:49:18.000Z (about 1 year ago)
• Default Branch: dev
• Last Pushed: 2024-01-08T19:46:05.000Z (12 months ago)
• Last Synced: 2024-05-17T15:42:35.482Z (7 months ago)
• Topics: mvc-architecture, postgresql, ruby, ruby-on-rails
• Language: Ruby
• Homepage: https://budget-app-8wpl.onrender.com/
• Size: 333 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Recipe App ](#-recipe-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)

    - [Usage](#usage)

    - [Install](#install)

    - [Run tests](#run-tests)

    - [Deployment](#deployment)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 Budget App 

The **Budget App** is a mobile web application build on Ruby on Rails where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.

The design was made based on the Snapscan layout made by Gregoire Vella on Behance.

# 🎥 Presentation video

* [Follow this link](https://drive.google.com/file/d/1sYThPupwEd6hsfnNaWhBPLvemaGte41G/view?usp=sharing)

## 🛠 Built With 

### Tech Stack

  Back-end

  


    
Ruby on Rails (v 7.0.8)

    
PostgreSQL

  


  Front-end

  


    
HTML5

    
CSS3

    
ERB template

    
JavaScript

  


### Key Features

* Use of Rails framework.

* MVC architecture.

* Save and retrieve information from a PostgreSQL database.

* Log in and registration with Devise gem.

* Integration and unit tests with Capybara and RSpec.

* Authorization with CanCanCan gem.

* Find and solve N + 1 problems with Bullet gem.

(back to top)


## 🚀 Live Demo 

* Live demo link

(back to top)


## 💻 Getting Started 

### Prerequisites

In order to run this project you need to have:

- Installed Ruby (v 3.2.2).

- Installed PostgreSQL.

- If you're using Windows, have installed WSL.

- If you're using MacOS, an option is using UTM.

### Setup

To clone this repository to your desired folder, run the following command: 


```

git clone [email protected]:Luffytaro22/Budget-app.git

```

(back to top)


### Usage

To open a local server, type the following command:

```

rails server

```

(back to top)


### Install

To install all the ruby gems, use the following command:

```

bundle install

```

To install the npm dependencies, use the following command:

```

npm install

```

After installing the gems, run this command to create and migrate a database:

```

rails db:create db:migrate

```

(back to top)


### Run tests

To run the RSpec unit and integration tests, use the following command:

```

rspec

```

(back to top)


### Deployment

You can deploy this project from the following link:

* Live demo link

(back to top)


## 👥 Authors 

👤 **Manuel Sánchez**

- GitHub: [@Luffytaro22](https://github.com/Luffytaro22)

- LinkedIn: [Manuel Sánchez](https://www.linkedin.com/in/manuel-alejandro-sanchez-sierra/)

(back to top)


## 🔭 Future Features 

- [ ] Allow the user to delete and modify their categories and transactions.

- [ ] Implement an email confirmation.

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project please give it a star ⭐️

(back to top)


## 🙏 Acknowledgments 

I would like to give credits to the following:

* **Microverse** for this readme template.

* **Gregoire Vella on Behance** for his beautiful UI layout.

(back to top)


## 📝 License 

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

(back to top)