alessandrocm / node-template

A node template for rest api

restd

Api for the various services 🔥🔥🔥

Prerequisites

Software

Optional

(Windows)

• Install chocolatey, this is a package manager which helps install the required software.

(Mac OSX)

• Install homebrew, this is a package manager which helps install the required software.

Required

• git (...Duh):
  • (Manually) Go to https://git-scm.com and download the latest version of git.
  • (homebrew) brew install git
  • (chocolatey) choco install git
• Nodejs:
  • (Manually) Go to www.nodejs.org and download the latest stable version. (At the moment it is LTS v10)
  • (homebrew) brew install node
  • (chocolatey) choco install nodejs.install
• gulp (requires Nodejs)
  • From the command line run: npm install -g gulp

Getting Started

Clone the repo:

$ git clone https://github.com/alessandrocm/node-template.git
$ npm i

Run

$ npm start

Is it running? Good work, go ahead and pat yourself on the back. Well done sir or lady. 😎

Tasks

Test Tasks

This task runs all the API tests in the /test/api directory.

$ npm test

BDD Test Tasks

This task runs all the BDD tests in the /test/bdd directory.

$ npm run bdd

API Documentation

With the api running go to http://localhost:3000/api-docs to view swagger documentation.