postal-middleware v1.0.0

POSTAL-MIDDLEWARE

Connect our services to print provider.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

It has been designed to be run inside docker containers. Dockerfile, Makefile, and docker-compose files are provided.

So you can start coding without the hassle of preparing your environment.

clone repo
make up-build

🔩 Prerequisites

What things you need to install the software and how to install them.

• Docker

🐳 Containers

• Service
  • Port : 3000

✅ Run it

First time use:

$ make up-build

Next times:

$ make up (background mode)
or
$ make up-i (interactive mode)

🙌 Useful command lines

to show the sysout of the application

$ make logs

Testing

# unit tests
$ npm run test

# e2e tests
$ make e2e

👷 Built With

• NodeJS
• NestJS
• Eslint
• Husky
• Docker
• Apillow
• Jest
• Swagger
• Logger (pino)

📚 Documentation

• See API's documentation
• See technical documentation