/code-words-api

Node API for code-words game

Primary LanguageJavaScript

Code Words API

Maintainability Issue Count Test Coverage CircleCI

A Node API for Code Words, a game where you guess words. Docs available at GitHub Page

Setup

Copy .env.example to .env and generate a SECRET_TOKEN for development:

node -e "console.log(require('crypto').randomBytes(32).toString('hex'));"

Replace <SECRET_TOKEN> in your new .env with this token. Replace the other <BLAH> things in your new .env with real values (e.g. Database credentials).

Then run:

$ yarn install
$ yarn migrate-up

Run the App

yarn start

This app uses foreman-node, so start wraps node server.js (in the Procfile) with nf start.

Testing

  • yarn test is just a shortcut for nf run mocha.
  • yarn cov runs the test suite inside nyc for coverage reporting.