Skip to content

Latest commit

 

History

History
98 lines (60 loc) · 2 KB

README.md

File metadata and controls

98 lines (60 loc) · 2 KB

Corner

Helping drive every day usage of crypto at corner stores and beyond

tweet

link

Installation

OS X & Linux:

Postgres

brew install postgresql

Ruby on Rails

If you do not have Rails, use this guide.

Development setup

For code quality purposes, we use Rubocop. Download for your specified IDE. Circle CI will fail if any Rubocop style violations are found.

We use two files for Environment Variables. The .env file is included in the repo and has public env vars.

Create files named .env.local and .env.test.local to hold secret env vars. In the .env file look at the section titled: Secret Environment Variables.

Copy the key value pairs to .env.local and .env.test.local. Then find someone on the team to share the values with you.

To ensures all dependencies are available to your application.

bundle install

Make sure Postgres is running. Run to set up your database.

rake db:create:all

and

bin/rails db:migrate RAILS_ENV=development

To run all servers (web and workers) locally:

foreman start -f Procfile.dev

note you won't be able to use binding.pry

OR

If you want to use binding.pry (because its the coolest) start the servers seperately in their own tabs:

rails server

and

< TODO: sidekiq startup goes here >

and then navigate to localhost:3000

Data Model

Keep this updated:

https://drive.google.com/file/d/13rWZlBrkVmeWPsVDByswylRkaf30jm_F/view?usp=sharing

Contributing

  1. Fork it (https://github.com/yourname/yourproject/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request