Emreozgun/insider-case-study

Product Management API

Table of Contents

• Introduction
• Usage
• Commands

Introduction

• An application will be developed for a product management system.
• The application will have a swagger documentation.

Swagger Documentation

• You can find the swagger documentation in the following link:
  • Swagger Documentation

Usage

Clone the repo with ssh:

git clone git@github.com:Emreozgun/insider-case-study.git

Clone the repo with https:

git clone https://github.com/Emreozgun/insider-case-study.git

To run test docker-compose file:

yarn docker:build-test

To start docker containers:

yarn docker:up

To down docker containers:

yarn docker:down

To run remove containers and images:

yarn docker:rm

Testing:

# run all tests
yarn test

# run all tests in watch mode
yarn test:watch

# run test coverage
yarn coverage

To run ESLint:

yarn lint

Fix ESLint errors:

yarn lint:fix

To run prettier:

yarn prettier

Fix prettier errors:

yarn prettier:fix