Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/danifromecuador/budget

This Ruby on Rails project is about building a mobile web app where the user can manage his budget. Them will provide list of transactions associated with a category.
https://github.com/danifromecuador/budget

postgresql rails render-deployment ruby

Last synced: 10 days ago
JSON representation

This Ruby on Rails project is about building a mobile web app where the user can manage his budget. Them will provide list of transactions associated with a category.

Awesome Lists containing this project

README

        


Budget App

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Live Version](#live-version)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Budget App

**Budget App** is an web app built with rails and uses postgresql. The user can log in, create new categories and new records for their expenses. Each category has a name and an icon, and each expense has a name, amount and a category. The user also can see the amount for each category and the total amount for all categories.

## 🛠 Built With

### Tech Stack

Client

### Key Features
- **The page is built with Ruby on Rails**
- **The desing is for mobile first approach**
- **For handling user's log and register the App uses device gem**

### Live Version
[Budget App](https://budget-aody.onrender.com/)

(back to top)

## 💻 Getting Started

### Prerequisites

In order to run this project you need:

- Install Git
- Install Ruby and Rails
- Install Postgres
- You can use your favorite CLI and code editor.
### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:danifromecuador/budget.git
```

### Install

Install this project with:

```sh
cd budget
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails s
```
Your project should be displayed automatically on your web browser on this port: http://localhost:3000/, if don't open it manually.

(back to top)

## 👥 Authors

👤 **Dani Morillo**

- GitHub: [@danifromecuador](https://github.com/danifromecuador)
- Twitter: [@danifromecuador](https://twitter.com/danimorilloc)
- LinkedIn: [danielfromecuador](https://www.linkedin.com/in/danielfromecuador/)

(back to top)

## 🔭 Future Features

- **More category icons will be added**
- **The user will be able to filter the expenses by amount**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/danifromecuador/budget/issues).

(back to top)

## ⭐️ Show your support

If you like this project give me a star on my [GitHub Repo](https://github.com/danifromecuador/budget)

(back to top)

## 🙏 Acknowledgments

I want to thanks to [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) for providing the [design guidelines](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=) used in this project.

(back to top)

## 📝 License

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

(back to top)