Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sevlamare/wallet


https://github.com/sevlamare/wallet

database-diagram heroku-deployment rails ruby ruby-on-rails rubyonrails

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# WalletGroup
> An app where you can manage your cash flow.

![screenshot](docs/screenshot.png)


The main point of this project is to deploy a working app, starting from the stretch, following the good practices.

## Content

* [Live Demo](#live-demo)
* [Business requirements](#business-requirements)
* [Potential future features](#potential-future-features)
* [Built With](#built-with)
* [Database Diagram](#database-diagram)
* [Getting Start](#getting-start)
* [Contributing](#contributing)
* [Acknowledgments](#acknowledgments)
* [Author](#author)
* [License](#license)

## Live Demo
You can access a deployed version of this app:

https://evening-wildwood-86896.herokuapp.com/

## Business requirements


    User


  • Create an account and make a login

  • Authenticate with username only


    Transactions and External transactions


  • Display total and a list with all transactions

  • Authenticate with username only


    Groups


  • Create groups

  • See a list with all groups

  • See transactions by groups


    Design


  • Mobile App

## Potential future features


  • Chart with incomes x outcomes

  • Search feature

  • Responsive Design

  • Checklist while creating an account

## Built With

- Ruby 2.6

- Ruby on Rails 5.2

- Postgres

- Rubocop and Stylint (Linters)

- GitHub Actions (CI Tool)

- Git, Github and VScode

## Database Diagram
![erd](docs/diagram.png)

## Getting Start

#### Install
To use this program, you will need to install:
* Ruby Language - Version 2.6 - [Install guide](https://www.ruby-lang.org/en/documentation/installation/)

* Ruby on Rails - Version 5.2 - [Install guide](https://guides.rubyonrails.org/v5.0/getting_started.html#installing-rails)

#### Get a local copy
Now you need a copy of this application, if you are using Git:
```js
git clone [email protected]:SevlaMare/wallet.git
```
Otherwise just hit (Download Zip) on the green button (Code) at top of this page.

#### Setup

Install all dependencies with:

```
bundle install
```

Setup database with:

```
rake db:schema:load
```
and populate the database with defaults using:
```
rails db:seed
```

#### Run App
To run, from the application folder, just type on terminal:
```js
rails server
```
Now you can go to your favorite web browser like Google Chrome and access the URL

http://localhost:3000

### Contributing

Contributions, issues and feature requests are welcome!

You can do it on [issues page](issues/).

## Acknowledgments

A special thanks to the code reviewers.

## Author

👤 **Thiago Miranda**

- Github: [@SevlaMare](https://github.com/SevlaMare)
- Twitter: [#SevlaMare](https://twitter.com/SevlaMare)
- Linkedin: [SevlaMare](https://www.linkedin.com/in/sevla-mare)

### License
Design idea by [Gregoire Vella](https://www.behance.net/gregoirevella) on Behance.

Creative Commons • July 2020