From 635e5328bd4c2299404d5a42fd0acf03e1879729 Mon Sep 17 00:00:00 2001 From: Bryan Terce Date: Tue, 25 Aug 2020 22:15:26 -0700 Subject: [PATCH] Add dev environment instructions to README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 53de2f2..b39f1c7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ # SBHacks API +## Setting up your development environment + +- Clone this repo +- Install ruby 2.7.1, preferably using [rvm](https://rvm.io/rvm/install#basic-install) +- Install [PostgreSQL](https://www.postgresql.org/download/) + (Note: PostgreSQL must be installed before you run `bundle install`) +- Run `bundle install` to install dependencies +- Run `rails db:create` to create a development and test database (PostgreSQL must be running!) +- Run `rails db:schema:load` to load the database schemas onto the development and test databases +- Run `rails db:seed` to load initial data into the development database +- Obtain the `development.key` and put it in `config/credentials`. This is used for decrypting the encrypted + secrets file. \ No newline at end of file