zerothebahdman / merch-api

RESTFul API for the Merchro Application

Introduction: WIP

Manual Installation

Clone the repo:

git clone https://github.com/merchro/merchro-api.git
cd merchro-api

Install the dependencies:

yarn install

Set the environment variables:

cp .env.example .env

# open .env and modify the environment variables

Commands

Running locally:

yarn dev

Running in production:

yarn start

Testing:

# run all tests
yarn test

# run all tests in watch mode
yarn test:watch

# run test coverage
yarn coverage

Docker:

# run docker container in development mode
yarn docker:dev

# run docker container in production mode
yarn docker:prod

# run all tests in a docker container
yarn docker:test

Linting:

# run ESLint
yarn lint

# fix ESLint errors
yarn lint:fix

# run prettier
yarn prettier

# fix prettier errors
yarn prettier:fix

API Documentation

To view the list of available APIs and their specifications, run the server and go to http://localhost:${PORT}/v1/docs in your browser. This documentation page is automatically generated using the swagger definitions written as comments in the route files.

API Endpoints

List of available routes: This will be referenced to the public swagger or postman docs later.