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

https://github.com/sambeck87/budget_app

The 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. This app allows the user to: register and log in, so that the data is private to them. introduce new transactions associated with a category.
https://github.com/sambeck87/budget_app

bootstrap device postgresql ruby ruby-gem ruby-on-rails

Last synced: about 1 year ago
JSON representation

The 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. This app allows the user to: register and log in, so that the data is private to them. introduce new transactions associated with a category.

Awesome Lists containing this project

README

          


logo
logo
logo


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [The Salary Manager app ](#the-salary-manager-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [Live Demo ](#live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [To get a local copy up and running, follow these steps.](#to-get-a-local-copy-up-and-running-follow-these-steps)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Author ](#-author-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)

# The Salary Manager app

**The Salary Manager app** allows you to 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.

This application allows you to:

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


This project allows you:

- Create users
- Create categories
- Delete your categories
- display a list of your categories
- Display the total amount spent
- Display the amount spent per category
- Create transactions
- Display a list of your transactions
- Display the amount spent per transaction


You can see a brief demonstration [here](https://www.loom.com/share/6d8b8c89add647c4b4f0dfcf6cce1762)

## 🛠 Built With
- Ruby
- Rails
- Postgresql
- Devise
- Rspec

### Tech Stack
- Visual code
- RoR
- PostgreSQL

### Key Features

- Use Postgres database.
- Use devise for authentication.
- Validate all user input to make sure that anyone with bad intentions cannot compromise the app.
- Use '.erb' view template engine

(back to top)

## Live Demo

- [Live Demo Version](https://salary-manager.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:

- Git
- A GitHub account
- Ruby installed
- Rails installed
- Postgresql installed

### Setup

Clone this repository to your desired folder:

- Go to this repo and copy the project link
https://github.com/sambeck87/Budget_app
- Open your terminal and clone the repo with this command
```
git clone https://github.com/sambeck87/Budget_app.git
```
- Now, you have a copy on your pc.

### Install

Install this project with:

- In your console run the command:
```
bundle install
```

### Usage

To run the project, execute the following steps:

- Setup the database:

- Create a new database by typing this command in your console
```
rails db:create
```
- Migrate the database using this command in your console

```
rails db:migrate
```

- Run the local host
```
rails s
```
- Open your browser and go to the following URL:
http://127.0.0.1:3000

### Run tests

To run tests, run the following command:
```
rspec spec

```

### Deployment

We will update this section soon

(back to top)

## 👥 Author

- 👤 **Sandro Hernandez**

- GitHub: [@sambeck87](https://github.com/sambeck87)
- Twitter: [@sambeck4488](https://twitter.com/sambeck4488)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/sandro-israel-hern%C3%A1ndez-zamora-899386a4/)

(back to top)

## 🔭 Future Features

- [ ] **It will implement email confirmations**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project
If you like this project give a ⭐️ or send us a message. We will appreciate

(back to top)

## 🙏 Acknowledgments

I would like to thank Gregoire Vella whose design inspired the creation of this application. You can see more of her work on [Behanse](https://www.behance.net/gregoirevella)

(back to top)

## ❓ FAQ

- **Can I run this app without Ruby?**

- No, you can't. You should install Ruby on your SO to use this app

- **Can I use the code of this project**

- Sure. We will be happy to collaborate on your projects. This project is MIT licensed.

(back to top)

## 📝 License

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

(back to top)