https://github.com/abdelaziz-mahdi/tidy-budget

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/abdelaziz-mahdi/tidy-budget

budget-app

Last synced: 28 days ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/abdelaziz-mahdi/tidy-budget
• Owner: Abdelaziz-Mahdi
• License: mit
• Created: 2023-11-20T20:44:24.000Z (almost 1 year ago)
• Default Branch: develop
• Last Pushed: 2024-05-06T19:26:01.000Z (7 months ago)
• Last Synced: 2024-05-17T15:35:58.597Z (6 months ago)
• Topics: budget-app
• Language: Ruby
• Homepage: https://tidybudget-zfwz.onrender.com
• Size: 813 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#  Tidy Budget App





  

  


  
TIDY BUDGET



# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [:movie_camera: Project Presentation](#project-presentation)

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

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

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Clone](#clone)

  - [Usage](#usage)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

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

- [⭐️ Future Features](#future-features)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Tidy Budget 

**Tidy Budget App** The Tidy Budget app is a mobile web application where you can manage your budget, you have a list of transactions associated with a category to know easily how much money you spend on each.

## 🛠 Built With 

### Tech Stack 

  Languages &  bundlers

  


    
Ruby

    
Ruby on Rails

    
RSpec

  


Database

  


    
PostgreSQL

  


### Key Features 

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.

(back to top)


## :movie_camera: Project Presentation 

A walking-through portfolio outline.

- [Project Presentation Link](https://www.loom.com/share/c76dabbdb7e640e7b81b7f32079f5eb4?sid=46eecc2f-d356-4502-893a-e3a838bfbefd)

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://tidybudget-zfwz.onrender.com/)

(back to top)


## 💻 Getting Started 

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

### Prerequisites

To run this project you need:

Download and Install the latest Ruby distributions.

[Download Ruby](https://www.ruby-lang.org/en/downloads/)

### Setup

- *Docs*

[Installation Documentation](https://www.ruby-lang.org/en/documentation/installation/)

### Clone

- Clone this repo to your local machine using `https://github.com/Abdelaziz-Mahdi/blog-app.git`

### Usage

Run the following commands on your terminal:

- bundle install

- rails s

(back to top)


## 👥 Authors 

👨🏼‍🚀 **Abdelaziz Mahdi** 🐱‍👤

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

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

- LinkedIn: [in/abdelaziz-mahdi](https://www.linkedin.com/in/abdelaziz-mahdi)

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Abdelaziz-Mahdi/tidy-budget/issues).

(back to top)


## ⭐️ Show your support 

Give a ⭐️ if you like this project!

(back to top)


## ⭐️ Future Feature 

- Design

- [x] Design guidelines >> [Snapscan](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=&) including:

    - Colors.

    - Typography: font face, size, and weight.

    - Layout: composition and space between elements.

- Interactions

- [x] Splash screen

- [x] Sign up and login pages

- [x] Home page (categories page)

- [x] Transactions page

- [x] "Add a new category" page

- [x] "Add a new transaction" page

- Testing

- [x] Create unit and integration tests for all the most important components of the application.

- Technical

- [x] Use Postgres as a database.

- [x] Use device gem for authentication.

- [x] Validate all user input to be sure that anyone with bad intentions cannot compromise the app.

- [x] App deployed and accessible online.

(back to top)


## 🙏 Acknowledgments 

- Project inspired by Microverse Program.

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