Mooncase-Apis

---

Requirements

• Install nvm(Node version manager) by using command

  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

• Installing Nodejs

  nvm install 16.13.1

• NPM version 6.14.4 or higher. See here for install instructions.
• Postman for API Testing. See here for downloading postman.
• Mongo DB for the database. See here for downloading.

Installation

• install all modules

  npm install --save

  yarn

start application

• If you want to start application

  npm start

  yarn start

API Endpoints

• All apis are as follow

  http://localhost:8000/api/{endpoint}

Swagger documentation

• All apis are documented with swagger

  http://localhost:8000/api-docs

.ENV

• Follow this .env for development purpose

  #Application info
  APPLICATION_PORT = 8000
  
  #Database info
  DB_NAME=
  DB_USER=
  DB_PASSWORD=
  DB_SERVER=
  DB_PORT=
  

Error Codes

• 500 - internal server error occurred, please try again
• 400 - invalid arguments, please try again
• 404 - data not found, please try again
• 401 - unauthorized request, please check again
• 403 - forbidden request, please check login credentials
• 409 - conflict happened, we do not allow duplicate entries, please try again.
• 200 - successful request

Contract deployed:

• Contract is deployed on kovan testnet on Ethereum Chain which could be found from below link: https://kovan.etherscan.io/address/0x0c5cf43642205D3f47f46AE501C46e687589e119