/humans-api

Node.js API test project

Primary LanguageJavaScript

humans-api

Node.js API test project

Table of Contents

Getting Started

Prerequisites

Installation

npm i

Usage

Set the environment variables

cp .env.example .env

Start the app

npm start

Documents

Documents are generated using swagger-jsdoc

To access full api reference run this command and open this link in the browser

npm run docs

Development

Linting

eslint and airbnb styles are used as the linter and styles

npm run lint

Tests

Tests are available under the test folder

npm test

Code Coverage

npm run coverage

Author

Ardalan Amini - @ardalanamini