Cash Machine

Cash machine app

Getting Started

Clone the project from https://github.com/{username}/cash-machine.git

Prerequisites

Make sure you have installed the nodemon globally

Installing

• cd into the project folder
• run npm install
• start in dev env. npm run dev
• After starting the server access the api by http://localhost:8080/api/v1/cm/cash-machine/withdraw/{amount}

Running the tests

• Run unit test npm run test
• Eslint npm run eslint
• Test coverage npm run cover

API Documentation

• After running the server npm run dev you can access the doc - [http://localhost:8080/apidoc/]

And coding style

• Commit message format - https://conventionalcommits.org/

<type>(<scope>): <subject>
Ex: feat(001): Setup project

Authors

• Malinda R

License

This project is licensed under the MIT License - see the LICENSE.md file for details