kwanpat / fulfilment

Fulfilment

Fulfilment

This is a do testing from [MyCloudFulfillment] Backend Developer(Node.js) Test

Usage

Start Service

There are 2 containers to run up. One for warehouse service and another one for database.

$ docker-compose up warehouse

Down Service

$ docker-compose down

API Access

http://localhost:9000/api/0.0.1/

API

GET   /deposit-receipts
GET   /dispatch-receipts
POST  /inventory/deposit
POST  /inventory/dispatch/price
POST  /inventory/dispatch
PUT   /inventory/dispatch
GET   /deposit-receipt/{id}/inventories
GET   /dispatch-receipt/{id}/inventories
GET   /inventory/{id}
GET   /inventory/{id}/audit
GET   /inventoryType/{id}
POST  /payment/deposit
GET   /report/profit

Tip: Check it out the payload at online API document here

Tip: Or you can use postman script from here

Database Access

POSTGRES_USER: 'api'
POSTGRES_PASSWORD: 'api'
POSTGRES_DB: 'fulfilment'
POSTGRES_HOST: localhost
POSTGRES_PORT: 5001

Unit test

$ npm run unit-test

ER Diagram

Note:

• Designed from microservices concept.
• Currently, payment service didn't implement yet. Because I want to focus on warehouse service as following requirement. However, payment service are place in warehouse service just for temporary.

Roadmap

As my concept there are many thing todo. You can see pending features from trello board