Docs: Basic setup guide

This commit is contained in:
Ollie Bennett
2016-02-24 00:22:45 +00:00
parent 92b4efdb98
commit f3d34b50d2

15
docs/SETUP.md Normal file
View File

@@ -0,0 +1,15 @@
# Dev Environment Setup Guide
## Ruby on Rails Basic Setup
* Get Ruby ([rbenv](https://github.com/rbenv/rbenv) or [rvm](https://rvm.io/) recommended.
* Install PostgreSQL (eg. `brew install postgres` or via [PostgreSQL.org](http://www.postgresql.org/download/)).
* Run `bin/setup` to setup [Bundler](http://bundler.io/), install gem dependencies and configure the databases.
* Run `rake test` to execute the test suite.
* Run `rails server` to begin the server at [localhost:3000](http://localhost:3000/)!
* Configure your copy of Helpy in `config/settings/<your-environment>.yml`.