Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/claudiarojassoto/budgetapp

Mobile budget app for user-friendly financial management, including registration, transaction tracking, secure authentication
https://github.com/claudiarojassoto/budgetapp

controllers crud database devise models postgresql ruby-on-rails views

Last synced: 14 days ago
JSON representation

Mobile budget app for user-friendly financial management, including registration, transaction tracking, secure authentication

Host: GitHub
URL: https://github.com/claudiarojassoto/budgetapp
Owner: ClaudiaRojasSoto
License: mit
Created: 2023-09-20T20:18:41.000Z (over 1 year ago)
Default Branch: develop
Last Pushed: 2023-12-07T19:13:21.000Z (about 1 year ago)
Last Synced: 2024-12-26T01:32:08.324Z (27 days ago)
Topics: controllers, crud, database, devise, models, postgresql, ruby-on-rails, views
Language: Ruby
Homepage:
Size: 246 KB
Stars: 6
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        

  
The Budget App


# 📗 Table of Contents

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

- [📖 The Budget App ](#-the-budget-app-)

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

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [💻 Explanatory Video ](#-explanatory-video-)

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

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

  - [👥 Author ](#-author-)

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

  - [🤝 Contributing ](#-contributing-)

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

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [❓ FAQ (OPTIONAL) ](#-faq-optional-)

  - [📝 License ](#-license-)

# 📖 The Budget App 

**The Budget App** is a mobile web application designed for efficient budget management. With this app, users can register and log in to maintain their personal financial records. They can add new transactions associated with specific categories and gain insights into their spending patterns by tracking expenses within each category. The app adheres to best practices in Ruby development, follows a well-defined design inspired by Gregoire Vella's work on Behance, and ensures the security of user data through the use of authentication and input validation. The project also includes unit and integration tests for critical components, utilizes Postgres as the database, employs Devise for authentication, and provides thorough documentation, including a brief project video showcasing its features.

## 🛠 Built With 

### Tech Stack 

  Technologies

  


    Ruby on Rails

  


Linters

  


    Rubocop

    Style lint

  


### Key Features 

- [x] **User Registration and Authentication**

- [x] **Category Management**

- [x] **Transaction Logging**

- [x] **Financial Summary**

- [x] **Transaction History**

- [x] **Transaction Logging**

- [x] **Security and Data Validation**

- [x] **Intuitive User Interface**

(back to top)


## 💻 Explanatory Video 

- [Explanatory Video](https://www.loom.com/share/227b3392ea7a469aa630f4119a301a2b?sid=f2cf8ea1-104f-4a43-824a-29900cbb0633)

(back to top)


 🚀 Live Demo 

- [Live Demo Link](https://budget-app-047t.onrender.com)

(back to top)


## 💻 Getting Started 

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

### Prerequisites

You need ruby and bundler

### Setup

Clone this repository to your desired folder:

sh 


cd my-folder 


git clone https://github.com/ClaudiaRojasSoto/BudgetApp.git

### Install

Install this project with:

- gem install rails

- bundle install

### Usage

To run the project, execute the following command:

rails server

### Run tests

To run tests, run the following command:

rspec spec

(back to top)


## 👥 Author 

👤 **Claudia Rojas**

- GitHub: @ClaudiaRojas

- LinkedIn: @ClaudiaRojas

(back to top)


## 🔭 Future Features 

- [ ] **Session History**

- [ ] **Currency Configuration**

- [ ] **Reports and Analysis**

- [ ] **Data Export**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project please feel free to send me corrections for make it better I would feel glad to read your comments.

And think If you enjoy gift me a star.  

(back to top)


## 🙏 Acknowledgments 

 - Creative Commons license of the design and Gregoire Vella on Behance for her Original design idea.

 - Microverse for providing the opportunity to learn Git and GitHub in a collaborative environment.

 - GitHub Docs for providing a wealth of information on Git and GitHub.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **Can I use with a templeate your project?**

  - Of course I would feel honored

- **Your project is free license?**

  - Yeah, you can use it completely

(back to top)


## 📝 License 

This project is licensed under the MIT License - you can click here to have more details [MIT](MIT.md).

(back to top)