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

https://github.com/juandbta/my-finances

This app is about building a mobile web application 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/juandbta/my-finances

databases deployment postgresql rspec ruby-on-rails

Last synced: 3 months ago
JSON representation

This app is about building a mobile web application 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.

Awesome Lists containing this project

README

        

MY FINANCES APP



logo

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [📽️ Video Intro](#video)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 [MY FINANCES APP]

**[MY FINANCES APP]** This app is about building a mobile web application 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.

I created a Ruby on Rails application that allows the user to:

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

## 🛠 Built With

1- Ruby 3.2.2

2- Rails 7.0.7.2

3- PostgreSQL

4- Gitflow

5- Rubocop

6- RSpec

### Tech Stack

Client

Ruby

Rails

Database

### Key Features

- **[Set up the repository and tools]**
- **[Created models according to the ERD diagram.]**
- **[Implemented the authentication and authorization using Devise]**
- **[Created the page to add a category]**
- **[Created the splash page]**
- **[Created registration and login page]**
- **[Created the page to add a transaction]**
- **[Created the transactions page]**
- **[Added unit and integrations tests]**
- **[Deployed the project]**
- **[Recorded a video describing project]**

(back to top)

## 🚀 Live Demo

- [My Finances App](https://my-finances-h7t3.onrender.com/)

(back to top)

## 📽️ Video Intro

- [Loom Introduction Video](https://www.loom.com/share/39f75f13f3694e02a1c0de1a73850886?sid=ad7d1eb1-794b-44ef-816d-ae5cd76f2b5a)

(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:

Web Browser (Chrome recommended)

Code editor (VS recommended)

GitHub account

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone "https://github.com/JuanDBta/my-finances.git"
```
### Install

Go to your /my-finances-app folder:

```sh
cd my-finances-app
bundle install
```

### Usage

```sh
rails server
```

### Run Tests

```sh
rspec spec
```

### Deployment

You can deploy this project using:
[My Finances App](https://my-finances-h7t3.onrender.com/)

(back to top)

## 👥 Authors

👤 **Micronaut JUAN DAVID DIAZ**

- GitHub: [@JuanDBta](https://github.com/JuanDBta)
- Twitter: [@simplebetsas](https://twitter.com/simplebetsas)
- LinkedIn: [LinkedIn](https://linkedin.com/in/simplebet/)

(back to top)

## 🔭 Future Features

- [ ] **[Transaction Details Page]**
- [ ] **[Add animations and transitions]**
- [ ] **[Add more functionalities to navigation bar]**

(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 me a like, it doesn't cost you anything and it helps me a lot to keep working.

(back to top)

## 🙏 Acknowledgments

We would like to thank Bee in Student Success who is always avalaible to solve issues and Microverse for push us to work hard every day!

Credit goes to [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) whose original design was used.

(back to top)

## ❓ FAQ

- **["How can I see more projects associated with this author?"]**

- Check my [@JuanDBta](https://github.com/JuanDBta)

- **[How can I contact the author of this project?]**

- Check my [LinkedIn profile](https://linkedin.com/in/simplebet/) or email me at [email protected]

(back to top)

## 📝 License

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

(back to top)