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

https://github.com/ikennarichard/budget-buddy

This is a mobile web application where you can manage your budget: you have a list of transactions associated with a category, which shows how much money you spent and on what. Built with Rails
https://github.com/ikennarichard/budget-buddy

cancancan capybara devise microverse rails rspec-rails

Last synced: 7 months ago
JSON representation

This is a mobile web application where you can manage your budget: you have a list of transactions associated with a category, which shows how much money you spent and on what. Built with Rails

Awesome Lists containing this project

README

          

BudgetBuddy

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [ Project Demo](#project-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 BudgetBuddy

>This is a mobile web application where you can manage your budget: you have a list of transactions associated with a category, which shows how much money you spent and on what. Built with Rails.

![homepage](./app/assets/images/budget-buddy-homepage.PNG)

## 🛠 Built With

- `Ruby`
- `Ruby on rails`

### Key Features

- Display Categories
- Display transactions for each each category
- Add category that you want to track
- Add transactions for the category

(back to top)

## 🚀 Live Demo

[Live Demo](https://budget-buddy-j2ry.onrender.com)

(back to top)

## 🎥 Project Demo

[Video Demo](https://www.loom.com/share/8653d017edfb4ce59b4c79760943112f?sid=9ea18934-5404-432e-9052-17d99fea175d)

(back to top)

## 💻 Getting Started
To clone the repository in local environment try following steps.

```sh
git clone https://github.com/ikennarichard/Budget-Buddy.git
```

### Prerequisites
- Rails
- Ruby

## Setup

### Install

In the terminal, go to the file directory and run this command.

```sh
bundle install
```
### Get into development
- create database and run migrations

```sh
bin/rails db:setup
```
- start server

```sh
bin/rails server
```

### Run test
To run test, run the following command in the terminal
```sh
rspec
```

## 👥 Authors

👤 **Ikenna Richard**

- GitHub: [ikennarichard](https://github.com/ikennarichard)
- LinkedIn: [ikenna_richard](https://linkedin.com/in/ikenna_richard)

(back to top)

## 🔭 Future Features

- Delete transactions
- Link payments for transactions you want to track

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.

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

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgments
- Thanks to [Gregoire Vella](https://www.behance.net/gregoirevella) for his inspiring design on [Behance](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=&)
- [Microverse](https://www.microverse.org/)
- Coding Partners

(back to top)

## 📝 License

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

(back to top)