README

This README would normally document whatever steps are necessary to get the application up and running.

Things you may want to cover:

• Ruby version

  • 2.5.1
  • Use ruby-install and chruby
  • For convenience, add chruby to your .bashrc / .zshrc file
  • Check that you are currently using Ruby version 2.5.1 using ruby --version

• System dependencies

  • Ruby 2.5.1
  • Rails 5.2.1 (basically gem install rails -v 5.2.1 --no-rdoc --no-ri, see also this)
  • Postgresql 10
  • Yarn (this might help)

• Database installation

  • Check official docs
  • See here for creating roles.

• Configuration

  • bundle install
  • rails db:create
  • rails db:migrate
  • rails server (or rails s) to start the backend server
  • cd client/, then yarn install and yarn start to start the frontend server

• Mail Catcher

  • gem install mailcatcher
  • mailcatcher
  • open browser on http://localhost:1080

• How to run the test suite

• Services (job queues, cache servers, search engines, etc.)

• Deployment instructions

  • Files needed for deploy: Procfile, package.json (from root)
  • There is a bug with devise, we need to override User#tokens_has_json_column_type?
  • git remote add heroku https://git.heroku.com/foodroad.git (only the first time)
  • git push heroku HEAD:master

• ...