abahernest / foodhut-order-processing-microservice Goto Github PK

FoodHut App Base API Gateway for FoodHut; A simple food ordering application.

Order Processing Service Order creation and updates.

Dispatch Service Service Updates dispatch status of the order.

Proto Repo Proto files shared across the api gateway and 2 microservices

1. Ensure Node and Yarn are Installed

2. Ensure Protocol buffers are installed (Optional)

# for mac users
$ brew install protobuf

# for linux users
sudo apt install protobuf-compiler

3. Ensure Postgres Is Installed

1. Install Dependencies

$ yarn install

2. Generate fresh protobuf files (Optional)

$ yarn proto:install && yarn proto:all

1. Create a .env file from the data in .env.example file

2. Update .env file with database information that you've configured for the project

# development
$ yarn start

# watch mode
$ yarn start:dev

# production mode
$ yarn run start:prod

# unit tests
$ yarn test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

# generate migration
$ yarn generate:migration -- db/migrations/<migration_name>

# run migration
$ yarn run:migration

# revert migration
$ yarn revert:migration