Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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


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

Last synced: 26 days ago
JSON representation

Awesome Lists containing this project

README 

        







  
Personal BudgetApp  | Ruby on Rails Capstone Project





# 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

    - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [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)

- [📝 License](#license)



---



#  Personal BudgetApp 



**"Personal BudgetApp"**  is a Ruby on Rails web application designed for managing your budget. It allows users to keep track of their financial transactions, categorize expenses, and monitor spending habits. Key features of the app include user registration and authentication, creating and managing categories, adding transactions to categories, and providing insights into spending by category.



This is the ERD for the project:

![image](./erd_diagram.png) 



---



## 🛠 Built With 



### Tech Stack



The project is built using the following technologies:



* Ruby on Rails.

* PostgreSQL.

* RSpec.

* Rubocop.

* Stylelint.







---



### Key Features 



- [x] User Registration: Register an account securely.

- [x] Category Management: Create, edit, and delete spending categories.

- [x] Transaction Tracking: Add, edit, and delete transactions.

- [x] Total Amount View: See total spending per category.

- [x] User-Friendly Interface: Navigate with ease.

- [x] Responsive Design: Accessible on various devices.

- [x] Category Icons: Personalize with icons.

- [x] Testing: Ensure functionality and reliability.

- [x] Database: Efficient data storage with Postgres.

- [x] Clear Documentation: Understand how to use the app.



    

      
  • HTML & CSS3
    • 

      
  • Ruby on Rails
    • 

      
  • Linters

        
      

            
    • Rubocop
      • 

            
    • StyleLint
      • 

          
    

      
    • 

      
  • Follow Microverse's list of best practices
    • 




(back to top)



---



## 🚀 Live Demo 



- 🎤 [Project presentation: video demo](https://www.loom.com/share/a57b45a0708545d9bac18071ead813e2?sid=bbd6e390-585b-487b-8157-76dc5cb071ee)

- [Live Demo Link](https://budget-app-st58.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 to have:



- Installed Ruby and Ruby on Rails.

- 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 https://github.com/Ruthmy/budget-app

```



Navigate to the cloned repository and run the following command to install the necessary gems:

```

cd blog-app

bundle install

```



(back to top)



### Usage

Initialize it with

```

rails server

```

Then open `http://localhost:3000` in your browser.



(back to top)



### Test

To run the tests try the following command:

```

rspec spec

```



(back to top)



(back to top)



---



## 👥 Authors 



👤 **Ruth Abreu**



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

- Twitter: [@rury_exe](https://twitter.com/rury_exe)

- LinkedIn: [LinkedIn](https://linkedin.com/in/ruth-abreu)



(back to top)



---



## 🔭 Future Features 



Upcoming improvements:



- [ ] Allow users to set financial goals and track progress.

- [ ] User profiles with customizable avatars.



(back to top)



---



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](https://github.com/Ruthmy/budget-app/issues).



(back to top)



---



## ⭐️ Show your support 



If you like this project and know someone who might find it helpful, please share it.

Or give it a **star** ⭐️



(back to top)



---



## 🙏 Acknowledgments 



I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.



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)



---