/code-challenge-api

Code Challenge API!

Primary LanguageJavaScript

Overview

This is the API for the Set The Set Code Challenge.

An example of this API is hosted at:

example

The source code for this repository can be found here:

source

Documentation

An updated swagger API documentation for this API can be found here:

swagger

Usage

Use the API as a standard REST API

  • accepts standard HTTP get/post/put/delete
  • Accepts JSON as the content type (application/json) for requets and responses
  • cors enabled

Get Started

Requirements

Please ensure your operating system has the following software installed:

  • Git - see GitHub's tutorial for installation

  • Node.js (v8.3+) - use nvm to install it on any OS

    • After installing nvm you will need to run nvm install node
    • We also recommend you install yarn, which is an alternative to npm

  • MongoDB (v3.x+):

    • Mac (via brew): brew install mongodb && brew services start mongo

    • Ubuntu:

      sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 0C49F3730359A14518585931BC711F9BA15703C6
echo "deb http://repo.mongodb.org/apt/ubuntu "$(lsb_release -sc)"/mongodb-org/3.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.4.list
sudo apt-get update
sudo apt-get -y install mongodb-org

Usage

Development

The start script will start the server

npm:

npm start

yarn:

yarn start
Debugging

As similar to running any other node process, simply use the environment variable DEBUG:

npm:

DEBUG=* npm start

yarn:

DEBUG=* yarn start

You can also use NODE_DEBUG if desired to debug node internal modules.

Tests

We use ava and supertest for testing

npm:

npm test

yarn:

yarn test