https://github.com/iamraphson/vendor-system-api
https://github.com/iamraphson/vendor-system-api
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/iamraphson/vendor-system-api
- Owner: iamraphson
- Created: 2021-09-08T08:58:55.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-08T16:54:09.000Z (almost 5 years ago)
- Last Synced: 2025-02-11T09:49:34.588Z (over 1 year ago)
- Language: TypeScript
- Size: 192 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vendor Machine API
## Description
Design an API for a vending machine, allowing users with a “seller” role to add, update or remove products, while users with a “buyer” role can deposit coins into the machine and make purchases. Your vending machine should only accept 5, 10, 20, 50 and 100 cent coins
## Installation
```bash
$ git clone https://github.com/iamraphson/vendor-system-api.git
$ cd vendor-system-api
$ cp .env.exmaple .env #don't forget to update the DB credential
$ npm install
```
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
```
## Test
```bash
# e2e tests
$ npm run test:e2e
```
##Documentation
Navigate to ```http://localhost:3000/docs``` on your computer to view the openapi documentation.
## Technology Stack
* **Language**: [Javascript](https://www.typescriptlang.org/)
* **Web Framework**: [NestJS](https://docs.nestjs.com)
* **Database**: [Mysql](https://www.mysql.com/)
## Todo
- [x] Increase test coverage.
## License
Vendor Machine API is MIT licensed.