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

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

A budget app named SmartPocket Budget keeps track of all your expenses associated with categories.
https://github.com/katarighe/budget-app

microverse-projects microverse-rails-capstone rails rails-application

Last synced: 5 months ago
JSON representation

A budget app named SmartPocket Budget keeps track of all your expenses associated with categories.

Awesome Lists containing this project

README

          


SmartPocket Budget App


## πŸ“— Table of Contents

- [πŸ“– Budget-App ](#-budget-app)
- [πŸ›  Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [πŸš€ Live Demo ](#live-demo-)
- [πŸ’» Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [πŸ‘₯ Authors ](#-authors-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [πŸ“ License ](#-license-)

# πŸ“– SmartPocket Budget

A budget app named **SmartPocket Budget** keeps track of all your expenses associated with categories.

## πŸ›  Built With

### Tech Stack

Client

Server

Database

### Key Features

The main features include:

- Create new transactions to track your expenses.
- Update or delete existing transactions.
- Create new categories to classify your expenses by category.
- View the calculated total amount of expenses per category.
- Update or delete existing categories.

(back to top)

## πŸš€ Live Demo

- The Live Demo is available [here](https://moyen-budget.onrender.com/)
- Video of the app is available [here](https://www.loom.com/share/1d91c95ca961496cb673ad326cb1859f)

(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 >= 3.2.2
rails >= 7.0
postgres >- 15.3
```

### Setup

Clone this repository to your desired folder:

```bash
git clone https://github.com/katarighe/budget-app
```

### Install

Install this project with:

```bash
cd budget-app
bundle install
```

it will install the required gemfile for running the project

### Usage

to use this project:

```ruby
bin/rails server or
rails server
```

it will run the the server on ```localhost:3000```

to run tests:

```rspec
```

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Mohamed Aden Ighe**

- GitHub: [@katarighe](https://github.com/katarighe)
- Twitter: [@katarighe](https://twitter.com/katarighe)
- LinkedIn: [@mighe](https://linkedin.com/in/mighe)

(back to top)

## πŸ”­ Future Features

Here are some future features that could be added to the Budget app in the future.

- **Add Transactions & Animations**
- **Introduce a Desktop version**
- **Improve the overall UX / UI design**

These are just a few ideas for future features that could be added to the Budget app.

The specific features that are added will depend on the needs and wants of the users.

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

Give a star⭐️ or a thumbs up πŸ‘ if you like this project! You can visit my GitHub profile for more of my projects.

(back to top)

## πŸ™ Acknowledgments

- Project supervised by [Microverse](https://www.microverse.org/)
- [Creative Commons 4.0 License](https://creativecommons.org/licenses/by-nc/4.0/)
- Original design theme is by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella)
- [Link to the original design theme](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding) by Gregoire Vella

(back to top)

## πŸ“ License

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

(back to top)