Skip to content

README.md

Latest commit

 

History

History
25 lines (15 loc) · 633 Bytes

README.md

File metadata and controls

25 lines (15 loc) · 633 Bytes

Running the application

1. Prerequisites

  • docker
  • docker compose
  • Internet connection

2. Run the application

Run docker-compose up in the console. It will install all packages, build and run the application. You will know that the application is up and running when you see this message: info: Distributed town API is listening on port 3005

3. Documentation and Testing the application

Go to http://localhost:3005/api/docs You will see a swagger page with all available endpoints.

4. .env file

In order to run the application you need to have .env file for which you should contact the team

5.