Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/cesarherr/budget_app

This application is designed to help you manage your finances. This was develop with ruby on rails and postgresql
https://github.com/cesarherr/budget_app

capybara-rspec deployment devise postgresql ruby-on-rails

Last synced: 29 days ago
JSON representation

This application is designed to help you manage your finances. This was develop with ruby on rails and postgresql

Awesome Lists containing this project

README

        

Paid Ups

![paid_ups](https://github.com/CesarHerr/budget_app/assets/111262493/7d131533-ce87-4834-83eb-94932e5b6ea0)

# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [πŸ’» Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [πŸš€ Live Demo ](#-live-demo-)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [πŸ“ License](#license)

# πŸ“– Paid Ups

**Paid Ups**

This application is designed to help you manage your finances and expenses, assisting in maintaining clear financial organization for personal, family, or work-related finances.

## πŸ›  Built With

### Tech Stack

Ruby on Rails

PostgreSQL

Devise

Rspec

Capybara

Tailwind

(back to top)

## πŸ’» Getting Started

### Setup

1. Ensure you have Ruby 3.2.2 at least, installed on your system. You can check your Ruby version in the terminal by running:

```
ruby -v
```

2. You can clone the project :

Using HTTPS:

```
git clone https://github.com/CesarHerr/budget_app.git
```

### Installation

To run this project locally, follow these steps:

1. Open your terminal or command prompt.

2. Navigate to the directory where you have cloned or downloaded the Recipe App repository.

3. Run the following command to install any required dependencies:

```
bundle install
```
4. You need to make sure you have PostgreSQL installed and configured on your local computer beforehand, then create the database for the project:

```
rails db:create
```

5. Now you need to create the tables and relationships that the project needs:

```
rails db:migrate
```

### Usage

1. Once the setup is complete, ensure you are still in the directory containing the Recipe App files.

2. To run the app, execute the following command:

```
rails s
```

### Tailwind

1. You can install tailwind to use it in the project.

```
rails tailwindcss:install
```
2. You can run de server using this:

```
bin/dev
```

### Tests

To run the tests ensure you are in the directory containing the test files.

1. Run the tests using the following command:

```
rspec
```

(optional) If you have problem with a different version of 'regexp_parser', you can run the tests with the
version of the gemfile with this command:

```
bundle exec rspec
```

- All tests should pass without any errors or failures, ensuring that the code and its methods are functioning correctly.

(back to top)

## πŸš€ Live Demo

> You can see the live demo of this project: [click here](https://paid-ups-af6ec0783e54.herokuapp.com/)

> You can see the Video presentation: [click here](https://www.loom.com/share/77d634395995413983b2e9fb229a2454?sid=50ebbe57-4026-4927-94e3-2c9c5dd330ca)

## πŸ‘₯ Author

πŸ‘€ **CΓ©sar Herrera**

- GitHub: [@cesarherr](https://github.com/cesarherr)
- LinkedIn: [CesarHerr](https://www.linkedin.com/in/cesarherr/)

(back to top)

## πŸ”­ Features

- [x] **Create a Database**
- [x] **Add Migrations**
- [x] **Add Models**
- [x] **Add Controllers**
- [x] **Add Views**
- [x] **Add tests**
- [x] **Show Categories at index page**
- [x] **Show Categories by users**
- [x] **Show transactions by Category**
- [x] **Authentication User**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this project give it a star ⭐️

(back to top)

## πŸ™ Acknowledgments

**I would like to thanks [Gregoire Vella](https://www.behance.net/gregoirevella) for the design idea, and thanks to Microverse for giving us the opportunity to learn and grow as developers. 🌟**

(back to top)

## πŸ“ License

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

(back to top)