Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/santiagorodriguezbermudez/piggy-app

A Ruby on Rails mobile web app that helps you organize with your friends/family around projects (i.e. trips, kickoff business ideas, fix household problems, etc.) and save enough money to implement such projects. This is a project that is part of the Microverse program to learn Ruby on Rails. The app is deployed with Heroku and uses AWS for storing files (images) that users upload.
https://github.com/santiagorodriguezbermudez/piggy-app

heroku ruby ruby-on-rails

Last synced: about 3 hours ago
JSON representation

Host: GitHub
URL: https://github.com/santiagorodriguezbermudez/piggy-app
Owner: santiagorodriguezbermudez
Created: 2020-08-04T22:27:16.000Z (over 4 years ago)
Default Branch: develop
Last Pushed: 2023-01-19T20:17:19.000Z (almost 2 years ago)
Last Synced: 2023-03-06T17:11:37.432Z (almost 2 years ago)
Topics: heroku, ruby, ruby-on-rails
Language: Ruby
Homepage: https://glacial-peak-89059.herokuapp.com/welcome
Size: 13.1 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 31
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Piggy App

## Live Demo
[Live Demo Link](https://glacial-peak-89059.herokuapp.com/welcome)

## Video Demo
[Walkthrough Video Demo](https://www.loom.com/share/7f71eb8d307f4c31a78917ea4a7a3cae)

# App screenshots
drawing
drawing
drawing
drawing
drawing

## Built With
- Ruby v2.7.0
- Ruby on Rails v6.0.3.2

## Getting Started
- Fork the repository and create a local one on your computer
- Move to the repository inside the command line using `cd` and the path to the file
- Run `bundle install` and `rails db:migrate`
- Run `rails server` (in case you already have something running on port 3000 run `rails server -p 3001` where the number can be any port you want.)
- Inside your browser go to http://localhost:3000/, changing the port number in case you chose a custom one
- Explore the application

## Instructions
- Log in and add create your user
- Create a saving and add it to a specific project you want to contribute. In case you don't have any projects, create your first
- Go to your projects and checkout the contributions other's have provided to you

### Prerequisites

- Ruby: 2.7.0
- Rails: v6.0.3.2
- Postgres: >=9.5

### Usage
- Run `rails server` and run the App on your local server

### Run tests
- We used Rspec and Capybara with Selenium Chrome Driver for user testing.

If you want to run tests, please do the following:
1. Run `Rspec` on your command line and review the results.

### Deployment to Heroku
1. Create Heroku Application `heroku create`
2. Modify your gemfiles to deploy a Rails application.

```
group :development, :test do
gem 'sqlite3'
end

group :production do
gem 'pg'
end
```

3. Bundle install `bundle install --without production`
4. Push to Heroku `git push heroku master`
5. Migrate the database on Heroku: `heroku run rails db:migrate`
6. Check the live application: `heroku open`

## Project Roadmap
- Implement adding friend requests and looking for friends personal savings
- Create a dashboard with the most contributing members of the community

## Authors
👤 Santiago Rodriguez
- Github: [@srba87](https://github.com/santiagorodriguezbermudez)
- Twitter: [@srba87](https://twitter.com/srba)
- Linkedin: [srba87](https://linkedin.com/in/srba87)

## Credits
Layouts design by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella)

Icons made by Freepik from www.flaticon.com

## 🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check the [issues page](issues/).

## Acknoledgements

Special thanks to my Microverse team, mentor and peers:
- Ocicats Team
- Michael Threels
- Daniel Santander

## Show your support

Give a ⭐️ if you like this project!