Open Source Guide logo Open Source Guide

If you get confused at any point, please message us in Slack!

Docker makes this project easier to work with. But if you don’t know how to use Docker, and you want to get started fast, that’s OK too.


If you don’t want to use Docker

  1. Pull the repo
  2. Install and run a local redis client
  3. Install and run a local mongo client
  4. cp .env.example .env

In env file

  1. set RACCOON_REDIS_URL=localhost.
  2. set MONGO_HOST_TEST=mongodb://localhost/express-mongoose-es6-rest-api-development-test and NODE_ENV=test if setting up TEST environemnt.
  3. set MONGO_HOST=mongodb://localhost/express-mongoose-es6-rest-api-development and NODE_ENV=development if setting up DEVELOPMENT environemnt.

Get Running

  1. Download some Mongo data to use locally and unzip

Populate the database by running mongorestore –db sed-test sed-test-db

  1. Install and run the node project.

npm install (or yarn install)

npm start (or yarn start)

(Then check package.json for other builds)

Test the Backend

  1. use curl or Postman to make requests
  2. Use RoboMongo to see the data in the database

If you want to connect frontend to backend locally, swap the comments here.

Getting Started with SE Daily using Docker

  1. cp .env.docker_example .env
  2. Run docker-compose up

To get used to the codebase, it might help to solve an issue with the “good first issue” label.