This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
Installation method Fork github.com/ytbryan/codingshophouse. Clone to a directory of your choosing. Update Ruby version in Gemfile and .ruby-version from ‘2.2.1’ to ‘2.2.2’.
The Ruby version of this app is 2.2.2
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
Setup postgresql credentials in database.yml.
Run rake db:create codingshop-ryan_development and codingshop-ryan_test should be created. Run rake db:migrate to create all the tables necessary for the project.
-
How to run the test suite
rails server to start server
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
…
Please feel free to use a different markup language if you do not plan to run rake doc:app.