This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Install RVM
-
Install RVM with \curl -sSL https://get.rvm.io | bash
-
From terminal run source ~/.bash_profile
-
Install Ruby
-
Install ruby-2.3.1 with rvm install ruby-2.3.1 --disable-binary
-
Install Bundler
-
gem install bundler
-
Rails version
-
'~> 5.0.0'
-
System dependencies
-
Configuration
-
Database creation
-
Install Postgres
-
brew install postgresql
-
Database initialization
-
Change the postgres password ALTER USER postgres WITH PASSWORD 'root';
-
CREATE DATABASE cko_development;
-
Exit out of postgres \q
-
How to run the test suite
- Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...