Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

This mobile web app enables users to organize transactions into categories, providing a clear overview of the total expenditure for each category. Built with Ruby on Rails and PostgreSQL.
https://github.com/mohamedhnoor/budget-app

bootstrap devise heroku postgresql rspec-rails ruby ruby-on-rails

Last synced: about 4 hours ago
JSON representation

This mobile web app enables users to organize transactions into categories, providing a clear overview of the total expenditure for each category. Built with Ruby on Rails and PostgreSQL.

Awesome Lists containing this project

README

        


Budget App


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [Budget App ](#budget-app-)
- [video demo 🎥](#video-demo-)
- [Render Deploy 🚀](#render-deploy-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [Acknowledgments](#acknowledgments)
- [📝 License ](#-license-)

# Budget App

> This mobile web app allows users to create categories and add transactions to each category. The app will show the total amount spent on each category. The app is built with Ruby on Rails. The app is deployed on Render.

## video demo 🎥

https://user-images.githubusercontent.com/97671133/234506964-443990ab-8222-44c9-9ff0-9d4f1ad26f27.mov

## Render Deploy 🚀

[Live demo here](https://mhnoor-budget-app-4f1e29029dad.herokuapp.com/)

## 🛠 Built With

### Tech Stack

Server

back to top

## Key Features

- [x] register and log in
- [x] Add new category
- [x] Add new transactions associated with a category.
- [x] see the money spent on each category

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

- `Ruby --version 3.2.1`
- `Ruby on Rails --version ~> 7.0.4`
- `Postgresql`

### Setup

Clone this repository to your desired folder:

```sh
cd your_desired_folder
git clone https://github.com/MohamedHNoor/Budget-app.git
```

### Install

Install this project gems with:

- After cloning type `cd budget-app`.
- Run `bundle install` to install all gems.

### Usage

To run the project, execute the following command:

- Run `rails db:create` to create a new database
- Run `rails db:migrate` to migrate the db and build the schema
- Run `rails s` to start the server

### Run tests

- Run `rspec` to run the tests

back to top

## 👥 Authors

👤 **Mohamed Hassan Noor**

- GitHub: [@MohamedHNoor](https://github.com/MohamedHNoor)
- Twitter: [@MohamedHNoor](https://twitter.com/MohamedHNoor)
- LinkedIn: [@MohamedHNoor](https://www.linkedin.com/in/mohamedhnoor/)

back to top

## 🔭 Future Features

- [ ] **implement some UX**
- [ ] **decent desktop design**
- [ ] **Implement the left side menu**

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

back to top

## ⭐️ Show your support

Give a ⭐️ if you like this project!

back to top

## Acknowledgments

- Hat tip to anyone whose code was used
- Inspiration
- Credit to the original designer by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella)

## 📝 License

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

back to top