A RESTful Cards APIs using Node.js, Express, and Mongoose.
For installation, follow these steps:
Clone the repo:
git clone --depth 1 https://github.com/sirajhussain/katana_assignment
cd katana_assignmentInstall the dependencies:
yarn installSet the environment variables:
cp .env.example .env
# open .env and modify the environment variables (if needed)Running locally:
yarn devRunning in production:
yarn startTesting:
# run all tests
yarn test
# run all tests in watch mode
yarn test:watch
# run test coverage
yarn coverageDocker:
# 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:testLinting:
# run ESLint
yarn lint
# fix ESLint errors
yarn lint:fix
# run prettier
yarn prettier
# fix prettier errors
yarn prettier:fixThe environment variables can be found in the .env file.
# Port number
PORT=3000
# URL of the Mongo DB
MONGODB_URL=mongodb://127.0.0.1:27017/KatanaDBList of available routes:
Cards routes:
POST /v1/cards/createdeck - create a Deck\
{
"type": "FULL/SHORT",
"shuffled": true
}GET /v1/cards/opendeck/:deckId - open Deck
POST /v1/cards/drawcard - draw a Deck card\
{
"deckId": "62823913ba59bb910029f8c6",
"count": "5"
}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent