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

https://github.com/principlebrothers/budget_app

A mobile web application where one can manage their budget: a person will have a list of transactions associated with a category, so that they can see how much money they spent and on what.
https://github.com/principlebrothers/budget_app

css3 postgresql-database rails ruby

Last synced: 3 months ago
JSON representation

A mobile web application where one can manage their budget: a person will have a list of transactions associated with a category, so that they can see how much money they spent and on what.

Awesome Lists containing this project

README

          

logo

BUDGET BUDDY MOBILE WEB APPLICATION

# πŸ“— 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)
- [Deployment](#triangular_flag_on_post-deployment)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [πŸ“ License](#license)

# πŸ“– [BudgetBuddy]

**BudgetBuddy** is a mobile web application where one can manage their budget: a person will have a list of transactions associated with a category, so that they can see how much money they spent and on what. It was build on this [Entity Relationship Diagram](https://github.com/microverseinc/curriculum-rails/blob/main/capstone/images/erd_diagram.png)

## πŸ›  Built With

### Tech Stack

> [Ruby on Rails](https://guides.rubyonrails.org/) (simplify as Rails) is a server-side web application framework written in Ruby under the MIT License. Rails is a model–view–controller (MVC) framework, providing default structures for a database, a web service, and web pages. It encourages and facilitates the use of web standards such as JSON or XML for data transfer and HTML, CSS and JavaScript for user interfacing.

Client

Server

Database

### Key Features

> Key features of the application are

- **Sign up with authorization**
- **Add Transaction**

(back to top)

## πŸš€ Live Demo

> Add a link to your deployed project.

- [Live Link](https://budget-app-xk5s.onrender.com/)
- [Features Demo Link](https://www.loom.com/share/0c24f68f0c4e417995036c5a306ccfc0)

(back to top)

## πŸ’» Getting Started

> This project can be used by anyone for any good purpose.

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- Ruby and Rails on you operating system eg. for [Ubuntu 20.04](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-20-04)
- [Node.js](https://nodejs.dev/en/) installed
- [PostgreSQL](https://www.postgresql.org/) database installed

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/principlebrothers/Budget_App.git
```

### Install

Install this project with:

```sh
cd Budget_App

bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
bin/rails rspec spec
```

### Deployment

You can deploy this project using:

(back to top)

## πŸ‘₯ Author

πŸ‘€ **Ernest Anyewe Adonu**

- GitHub: [@principlebrothers](https://github.com/principlebrothers)
- Twitter: [@adonu_ernest](https://twitter.com/adonu_ernest)
- LinkedIn: [Ernest Anyewe Adonu](www.linkedin.com/in/ernest-anyewe-adonu)

(back to top)

## πŸ”­ Future Features

- Will be specified soon ...

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/principlebrothers/Budget_App/issues/new).

(back to top)

## ⭐️ Show your support

If you like this project buy the team a [drink](.../.../)

(back to top)

## πŸ™ Acknowledgments

- I would like to thank [Microverse](https://www.microverse.org/) for bring up this project to help implent rails design concept.
- I will like to acknowledge [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) who was creative to design this project
- I will like to acknowldge [Creative Commons](https://creativecommons.org/licenses/by-nc/4.0/) for setting a legal plateform to preseve the hardwork of content creator.
- I will like to ackknowledge [Render](https://render.com/) for making it possible to beginner to deploy their app on their website

(back to top)

## ❓ FAQ

- **Is Rails still relevant?**

- [Yes, Rails is still popular among developer](https://blog.railwaymen.org/is-ruby-on-rails-dead)

- **Is it easy to learn Ruby on Rails**

- [It is very easy to learn compared to most of the programming languages](https://careerkarma.com/blog/why-learn-ruby-on-rails/)

(back to top)

## πŸ“ License

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

(back to top)