Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Budget-App is 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/oguntayomicheal/budget-app

postgresql ruby-gem ruby-on-rails

Last synced: 25 days ago
JSON representation

Budget-App is 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.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Video 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)

# 📖 [Budget-App]

**[Budget-App]** is 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.

## 🛠 Built With Ruby on Rails

### Tech Stack

- Ruby
- Rails
- PostgreSQL

Server

Database

### Key Features

- **[Login/ Registration page]**
- **[Categories page]**
- **[Transactions page]**

(back to top)

## 🚀 Live Demo

- [Live demo link](https://budget-app-jvqh.onrender.com)

(back to top)

## 💻 Video Demo

- [Video demo link](https://www.loom.com/share/0f1b2683575e487c8adaab1b862e6dec?sid=cc654994-cd72-4d5e-8b40-2406fe0ce935)

(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 installed on your computer. Download Ruby via the [official website](https://www.ruby-lang.org/en/downloads/)
- Install rails. Run gem install rails
- You also need to have PostgreSQL installed

### Setup

Clone this repository to your desired folder:

- `git clone [email protected]:oguntayomicheal/Budget-App.git`
- `cd Budget-App/`

### Install

Install this project with:

- run `bundle install` to install necessary gems

### Usage

To run the project, execute the following commands:

- `rails db:create db:migrate`
- `rails s`
- On your browser, type localhost:3000 to see the app

### Run tests

To run tests, run the following command:

- `rspec spec`

(back to top)

## 👥 Authors

👤 **Micheal Oguntayo**

- GitHub: [@oguntayomicheal](https://github.com/oguntayomicheal)
- Twitter: [@OguntayoMicheal](https://twitter.com/Oguns_micky)
- LinkedIn: [@OguntayoMicheal](https://www.linkedin.com/in/ogunsmicky/)

(back to top)

## 🔭 Future Features

- **[Implement destroy functionality for a transaction]**
- **[Implement edit and update functionalities for both the category and transaction]**
- **[Add tablet and desktop styles to the web app]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

Give this project a ⭐️ if you like it.

(back to top)

## 🙏 Acknowledgments

- This design was an inspiration by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella), the author of the original design.
- Hat tip to Microverse for the guidance and provision of Ruby on Rails learning materials.

(back to top)

## 📝 License

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

(back to top)