kapp-api
Karunya App's API built with node.js and mongodb.
Setup
Prerequisites
Before starting to test this API locally you need to assure you have the following prerequisites:
-
Node.JS see: Installing Node.js
-
npm see: Installing npm
-
MongoDB see: Installing MongoDB
Installation and usage
- Clone the repo and install all the required packages:
git clone https://github.com/khacksOSS/kapp-api.git
cd kapp-api/
npm install
-
Run command
npm run dev
-
Test by sending requests at
localhost:2500
Testing
- To run all the tests with mocha:
npm run test
- To test with jest:
npm run test-jest
Commiting/pushing to repo
- Run prettier to indent code
npm run prettier:write
- Run eslint to check for potential bugs
npm run lint
- To auto fix few errors
npm run lint:fix