TRZ (The resident zombie) - API

🔭 Diagram Database

🚀 Technologies

• Typescript
• NodeJS
• Postgres
• TypeOrm
• Docker

🔌 Prerequisites

• NodeJS LTS (>= 12.x)
• Docker (>= 19.03.x)
• Docker Compose (>= 1.05.x)

ℹ️ Getting Started

1. Fork this repository and clone it on your machine.
2. Change the directory to trz-api where you cloned it.

🔐 Backend Getting Started

/* Run docker */
$ docker-compose up -d

/* Down docker */
$ docker-compose down

• Open backend, the host localhost:3333

🧰 Running the tests

/* Access container of backend */
$ docker exec -it api-container /bin/bash

/* Run test */
$ npm run test:coverage

🗒️ Swagger

With the server running, access http://localhost:3333/docs

📝 License

This project is under the MIT license. See the LICENSE for more information.

---