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.4
-
System dependencies
- mysqld
- redis
- yarn
-
Configuration
-
Setup
$ bundle install --path vendor/bundle
$ yarn install
$ brew services start redis
- Setup database
$ bin/rails db:setup
- API Document
$ AUTODOC=1 bundle exec rspec
- How to run the test suite
$ bundle exec guard
- How to run the local development server
# Run both servers
$ bin/webpack-dev-server
$ bundle exec sidekiq -C config/sidekiq.yml
$ rails s
$ bundle exec rackup # to view Sidekiq dashboard