Local Development

These instructions assume you are using Mac OS X. To set up a staging or production server, please follow script/ instead.

Found an issue? Feel free to suggest edits!

  1. Install tools
    1. Install Docker for Mac.
    2. Install Homebrew.
    3. Install node: brew install node
    4. Install dbmate: brew tap amacneil/dbmate && brew install dbmate
  2. Grab the code
    1. Clone the repository: git clone
    2. Enter the directory: cd sagefy
    3. Set up node modules: npm install
  3. Start it up
    1. Configure your environment. cp .env.example .env
    2. docker-compose up
  4. Get some data
    1. Create database schemas: npm run dbmate up
    2. Create dev data: npm run gendata
  5. Verify
    1. In your browser, visit http://localhost:2601/graphiql, there should be a Graphiql window.
    2. In your browser, visit http://localhost/, the home page should be working.
    3. Try to sign up for an account.
  6. Watch and rebuild
    1. npm install && npm start


To shut down local dev:

docker-compose down

Rebuild the containers (if config change):

docker-compose up --build

Restart a service manually:

docker-compose restart [servicename_1]

Access Postgres REPL:

npm run dbrepl

Run tests:

npm install && npm test

Wipe Docker completely:

docker rm -f $(docker ps -a -q)
docker rmi -f $(docker images -q)

Back up database

# ssh into the server


# ssh into the server