Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ab-noori/finance-tracker

The Ruby on Rails Budget-app project is aimed at creating a mobile web application that enables budget management, including user registration and login for data privacy, the introduction of new transactions linked to categories, and the display of expenditures per category.
https://github.com/ab-noori/finance-tracker

bootstrap-5 finance-management font-awesome postgresql-database render-deployment ruby-app ruby-gem ruby-on-rails unit-testing

Last synced: about 16 hours ago
JSON representation

The Ruby on Rails Budget-app project is aimed at creating a mobile web application that enables budget management, including user registration and login for data privacy, the introduction of new transactions linked to categories, and the display of expenditures per category.

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/Microverse-blueviolet)

> # Finance Tracker

| Project Login Page |
| ----------------------------------------------------------------------------------------------------------------------- |
| Finance-Tracker login |

# 📗 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)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 [Finance Tracker]

> **[Finance-Tracker]** The Ruby on Rails Budget-app project is aimed at creating a mobile web application that enables budget management, including user registration and login for data privacy, the introduction of new transactions linked to categories, and the display of expenditures per category.
## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

- **[Splash screen]**
- **[Sign up and log in pages]**
- **[Home page (categories page)]**
- **[Details page (transactions page)]**
- **["Add a new category" page]**
- **["Add a new transaction" page]**



| Implemented Schema's ERD |
|---------------------------------------|
|erd_diagram|

(back to top)

## 🚀 Live Demo & Project intro
- [Live Demo on Render](https://finance-tracker-kxhn.onrender.com/)
- [Introduction to the project](https://www.loom.com/share/c7ce63a4704c415cb1468873efd613c1?sid=620df90d-4fa9-4164-a5a6-7e41bf4ad07e)

> In this video, I introduce you to the Ruby On Rails capstone project, which is a budget application called the finance tracker. I walk you through the login page, the home page, and the transaction page, explaining the features and functionalities of each. I also demonstrate how to create a new category and add a new transaction. Finally, I show you the mobile version of the application. Watch this video to get an overview of the project and its key components.

(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:
- [Ruby on Rails](https://rubyonrails.org/) installed and running. To get more information, read the [installation guide](https://guides.rubyonrails.org/).

- [PostgreSQL](https://www.postgresql.org/) installed and running

(back to top)

##

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
https://github.com/ab-noori/Finance-Tracker.git
```

(back to top)

### Install

Install this project with:

```sh
bundle install
rails db:create
rails db:migrate
```

(back to top)

### Usage

To run the project, execute the following command:

```sh
rails server
```

(back to top)

### Run tests

To run tests, run the following command:

```sh
rspec spec
```

(back to top)

## 👥 Authors

👤 **Abdul Ali Noori**

- GitHub: [@ab-noori](https://github.com/ab-noori)
- Twitter: [@AbdulAliNoori4](https://twitter.com/AbdulAliNoori4)
- LinkedIn: [abdulali-noori](https://www.linkedin.com/in/abdulali-noori)

(back to top)

## 🔭 Future Features
- [ ] **[Applying the edit and delete options for categories]**
- [ ] **[Optimizing the project style for longer screen sizes]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ab-noori/Finance-Tracker/issues/new).

(back to top)

## ⭐️ Show your support

If you like this project, give it a star.

(back to top)

## 🙏 Acknowledgments

First, I would like to thank Microverse and my coding partners, and then I would like to give special credit to the creator of the design ([Gregoire Vella on Behance](https://www.behance.net/gregoirevella)) that I have used in my project.

(back to top)

## 📝 License

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

(back to top)