✨ API Boilerplate

Heroku

• Endpoint: https://endpoint/api/v1/
  
• Dashboard API: https://dashboard.heroku.com/apps/
  
• Postgres: https://data.heroku.com/
  
• Swagger: https://endpoint/api/v1/docs

---

🐳 Using Docker

To better understand about the ports that the services are running, check in: docker-compose

docker-compose up -d --build
docker-compose exec api npm run config:env
docker-compose exec api npm run typeorm:migration:run

To access db-admin, enter in browser: http://localhost:8080
user: postgres
password: postgres
database: api

---

📦 Run in Development mode

Some Documentations about internal scripts/heroku

npm run config:env
npm run typeorm:migration:run
npm run dev

---

🧪 Run unit tests

npm run test <---- Only run the test
npm run test:coverage  <----- Run test generating coverage text and html
npm run test:coverage:text <---- Run test generating only coverage text