Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/yasinabdmahmood/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, HTML5 and Bootstrap.
https://github.com/yasinabdmahmood/budget-app

bootstrap html5 ruby-on-rails

Last synced: about 2 months 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. Built with Ruby on Rails, HTML5 and Bootstrap.

Awesome Lists containing this project

README

        



logo

Budget App

# 📗 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](#video-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)

- [📝 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..

**[Budget app]** is a...

## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

- **[register and log in, so that the data is private to them]**
- **[introduce new transactions associated with a category]**
- **[see the money spent on each category]**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://budget-app-microverse.onrender.com)

(back to top)

## Video Demo

- [Video Demo Link](https://www.loom.com/share/74dccbfe84d1424895b97f2a2e790908)

(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: Visual Studio Code and Installed Rails.

### Setup

Clone this repository to your desired folder:

```bash command
$ git clone $ git clone https://github.com/yasinabdmahmood/Budget-app.git
```
### Navigate to the directory
```bash command
you@your-Pc-name:~$ cd
```
### Install

Install the dependencies:

```bash command
bundle install
```

### Usage

To run the project, execute the following command:

```bash command
` $ rails server`
```

### Run tests

To run tests, run the following command:
```bash command
$ rspec
```

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **Yaseen**

- GitHub: [@yasinabdmahmood](https://github.com/yasinabdmahmood)
- LinkedIn: [yaseen Abd alwahid](https://www.linkedin.com/in/yaseen-abdalwahid/)
- GitLab: [YASEEN ABD ALWAHID](https://gitlab.com/yasinabdmahmood)

(back to top)

## 🔭 Future Features

- [ ] **[Add Google sign-in authentication style]**
- [ ] **[New page to show annual budget report]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project

If you like this project make sure to give it a star

(back to top)

## 🙏 Acknowledgments

I would like to thank...
- [Microverse](https://www.microverse.org/)
- Original design idea by: [Gregoire Vella on Behance](https://www.behance.net/gregoirevella).
- [Creative Commons](https://creativecommons.org)

(back to top)

## 📝 License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)