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

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

Budget-App is a mobile web application where you can manage your budget and you can easily create an account and login to start managing your budget.
https://github.com/altontonn/budget-app

bootstrap5 postgresql render ruby-on-rails

Last synced: about 2 months ago
JSON representation

Budget-App is a mobile web application where you can manage your budget and you can easily create an account and login to start managing your budget.

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)
- [💻 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 and you can easily create an account and login to start managing your budget. A user can create groups to keep track of specific expenses and add transactions to those groups to stay on top of your spending. With this app, you can stay in top of list when coming up with financial plan.

## 🛠 Built With

### Tech Stack

- Ruby on rails
- PostgreSQL
- Bootstrap

### Key Features

- **[Account Creation]** - a user can create and sign in to his/her account to access their budget accounts
- **[Category Creation]** - a user can create category to organize their accounts and transactions, making it easy to track specific areas of their budget.
- **[Budget Tracking]** - With this, a user can stay within their budget

(back to top)

## 🚀 Live Demo

- [live-demo](https://budget-w99n.onrender.com/)

(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, rails and postgresql installed

### Setup

Clone this repository to your desired folder:

Example commands:

```sh
cd my-folder
git clone https://github.com/altontonn/Budget-app
```

### Install

Install this project with:

```sh
bundle install
```
### Usage

To run the project, execute the following command:

- To get it running on your machine, you may open the project on your IDE and open the terminal
- On the terminal you can run:

```sh
rails s OR rails server
```
### Run tests

To run tests, run the following command:

- For rubocop

```sh
rubocop a
```

- For test

```sh
rspec
```

(back to top)

## 👥 Author1

👤 **Author**

- Github: [altontonn](https://github.com/altontonn/)
- Twitter: [AlumasaNewton](https://twitter.com/AlumasaNewton)
- Linkedin: [newton-alumasa](https://www.linkedin.com/in/newton-alumasa/)

(back to top)

## 🔭 Future Features

- **Set up a edit and delete button**
- **Add basic UI**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

Give a ⭐️ if you like this project and how I managed to build it!

(back to top)

## 🙏 Acknowledgments

I would like to thank...

- [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) for the design

(back to top)

## 📝 License

This project is [MIT](https://github.com/altontonn/Budget-app/blob/dev/LICENSE) licensed.

(back to top)