Skip to content
This repository has been archived by the owner on Oct 27, 2019. It is now read-only.

Getting Started with Keystone Dev

Kyle Reis edited this page Oct 10, 2017 · 2 revisions

Mac Instructions

1. Install Homebrew

If you are using a Mac (especially for dev) you should be using homebrew, but if you aren't then run the command to install it.

 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install"  

2. Install MongoDB

brew install mongodb  

I'm not sure this is necessary since we will be accessing the production database. If someone wants to try skipping this step and letting me know if it still works, that would be great.

3. Install Node.js

brew install node@6

It is important that you make sure you install Node 6. Currently, the server will not run if you are using Node 7.

4. Clone the Repository

git clone git@github.com:CruCentralCoast/slocru-keystone.git

This assumes that you have GitHub set up with your ssh key. If you don't then you should set it up by following the instructions here

5. Install Dependencies

Navigate to the root of the project (you should see the package.json file)

npm install

6. Add .env File

Copy the template file.

cp dotenv.template .env

Fill in the newly created .env file with the values. If you have access to the Production server you can look up the values there. If not then you can get them from one of the dev leads.

7. Run the Server

node keystone

It may throw a bson error and the server might take a little bit of time to start. Both of these things are normal. If it takes more than a few minutes for the server to start make sure you are using Node 6. If it still isn't working let us know.