Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gvgesanto2/microverse-gs-money
GS Money is a Full-Stack budget application built with Ruby on Rails, Sass, and Postgres, where users can create different types of transactions (income and expenses) that can be organized into categories. Each category has its transactions, displaying the total amount spent and earned.
https://github.com/gvgesanto2/microverse-gs-money
css3 devise full-stack full-stack-web-development html5 javascript postgresql rails7 rspec ruby ruby-on-rails sass
Last synced: about 1 month ago
JSON representation
GS Money is a Full-Stack budget application built with Ruby on Rails, Sass, and Postgres, where users can create different types of transactions (income and expenses) that can be organized into categories. Each category has its transactions, displaying the total amount spent and earned.
- Host: GitHub
- URL: https://github.com/gvgesanto2/microverse-gs-money
- Owner: gvgesanto2
- Created: 2022-10-26T21:08:22.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2022-11-30T00:52:16.000Z (about 2 years ago)
- Last Synced: 2024-11-09T03:12:22.877Z (3 months ago)
- Topics: css3, devise, full-stack, full-stack-web-development, html5, javascript, postgresql, rails7, rspec, ruby, ruby-on-rails, sass
- Language: Ruby
- Homepage: https://gs-money.herokuapp.com/
- Size: 195 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GS Money
> This app helps you manage your budget by creating different categories of income and expenses. Each category have its own transactions, displaying how much you spent and what you bought. One transaction can be assigned to multiple categories, allowing a more flexible money administration.
## Built With
- **Languages & Technologies:**
- Ruby on Rails
- Sass
- Devise
- Postgres
- Docker
- **Conventions and Methodologies:**
- BEM
## Live Demo
Link to live demo: https://gs-money.herokuapp.com/
## Original Design Idea
This app's design idea was inspired by a Figma template provided by the [Rocketseat Bootcamp](https://www.rocketseat.com.br/).
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- [Ruby](https://www.ruby-lang.org/en/downloads/)
- [Rails](https://rubyonrails.org/)
- [Postgres](https://www.postgresql.org/) installed locally or [Docker](https://www.docker.com/) to run a container with Postgres installed
### Setup
Download the code from this repository, by following these two steps:
- Click on the ``Code`` button, above the files list.
- Click on the ``Donwload ZIP`` button to download the code.
### Install
#### 1- Install the project dependencies
1.1- Install the [Ruby Bundler](https://bundler.io/) using this command on the root project's directory:
```console
$ gem install bundler
```
1.2- Then, install all the project dependencies using this command:
```console
$ bundle install
```
#### 2- Set up the project's database
2.1- If you have Docker installed in your computer, create a Postgres image from the Dockerfile in this project using this command on the root project's directory:
```console
$ docker build -t pg-db .
```
2.2- Create and run a new Docker container using the Postgres image created in the last step:
```console
$ docker run --name gs-money-db -p 5432:5432 -d pg-db
```
#### 3- Build the project's database schema
3.1- Run the database migrations to build the project's database with the correct tables:
```console
$ rails db:migrate
```
### Usage
To use this application, run this command on the root project's directory:
```console
$ rails s
```
## Test
To test this application, run this command on the root project's directory:
```console
$ rspec
```
## Authors
👤 **Gabriel Santo**
- GitHub: [@gvgesanto2](https://github.com/gvgesanto2)
- Twitter: [@GabrielSanto997](https://twitter.com/GabrielSanto997)
- LinkedIn: [Gabriel Santo](https://linkedin.com/in/gabriel-santo-5882a71b2/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](./MIT.md) licensed.