Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

App made with Ruby on Rails where you are able to manage your spending.
https://github.com/hfg43/budget-app

backend database deployment devise-gem-extension gems mvc-architecture ruby-on-rails

Last synced: 10 days ago
JSON representation

App made with Ruby on Rails where you are able to manage your spending.

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)
- [πŸ’» 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 (OPTIONAL)](#faq)
- [πŸ“ License](#license)

# Smart Spend

**Smart Spend** is an application made with Ruby on Rails where you are able to manage your spending. You are able to create spend categories and transactions associated with each category. You are also able to see how much money you spend in each category.

[You can see a live demo here] (https://budget-app-eb8d.onrender.com)

## πŸ›  Built With

### Tech Stack

Client

Database

### Key Features

- **Use Devise for Authentication**
- **Set Up Postgres Database**
- **Create Data Models using ERD Diagrams**
- **Understanding the conventions of Rails**
- **Use Ruby on Rails to implement a NavBar**
- **Use Active Record to write SQL queries**
- **Include controllers actions**
- **Add test using Rspec & Capybara gems**
- **Add views following controller methods**
- **Review Linters**

(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:

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
https://github.com/HFG43/budget-app
```

### Install

Install this project with:

```sh
cd my-project
gem install
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
rspec .
```

### Deployment

You can deploy this project using:

[My portfolio deployment link] (https://budget-app-eb8d.onrender.com).

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **HernΓ‘n GΓΌemes**
- GitHub: [@HFG43](https://github.com/HFG43)
- LinkedIn: [hernanguemes](https://www.linkedin.com/in/hernanguemes)

(back to top)

## πŸ”­ Future Features

- **[Include scaning options for transaction inputs]**
- **[Use as wallet with payment options]**

(back to top)

## 🀝 Contributing

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

(back to top)

## ⭐️ Show your support

If you like this project you can give me a ⭐️

(back to top)

## πŸ™ Acknowledgments

Original design idea by Gregoire Vella under Creative Commons license.

Take a look to the fantastic desgin [here] (https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=)

I would like to thank Microverse for the opportunity and all my Microverse colleagues that helped us during this project.

(back to top)

## πŸ“ License

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

(back to top)