Development Setup

How to run with Docker Compose

Here, we offer three options to prepare the environment and launch TaskoMask services using a Docker Compose file:

1. Running the Environment Independently and debug or run specific services through your IDE:

If you wish to run or debug specific services, you'll need to ensure that the environment is properly configured, as certain services have dependencies such as MongoDB, Redis, and more. Follow these steps to prepare the environment:

Navigate to the /src/7-Docker/ directory using the command line interface (CLI).

Execute the following commands: ...\src\7-Docker> docker-compose -f Infrastructure.yml up -d

Now, the environment is ready, and you can run or debug specific services through the IDE (Visual Studio, etc.).

2. Running all services (TaskoMask application) without Debugging:

If you simply want to run all the services and their dependencies without the need for debugging, you can follow these steps:

Navigate to the /src/7-Docker/ directory using the command line interface (CLI).

Execute the following commands:

...\src\7-Docker> docker-compose build

...\src\7-Docker> docker-compose up -d

Then You can access various services of the application through the following URLs:

Website: https://localhost:5009

Identity Provider: https://localhost:5017

User Panel: https://localhost:5011

API Gateway: https://localhost:5001/swagger

Seq Dashboard: http://localhost:5340/

For all services, you can access to their metrics with /metrics url. For example, website metrics url is : https://localhost:5009/metrics

3. Running all services (TaskoMask application) with Debugging through Visual Studio:

If you need to run and debug all the services within Visual Studio, you can follow these steps:

• Modify the launchSettings.json file and set the desired services to start debugging in the default profile named "Docker Compose".
• Select "docker-compose" as the debugging item from Visual Studio Debug items list.
• Run the Debugger by pressing F5.

For more information, you can refer to related articles on Microsoft's documentation.

This option allows you to run and debug the service directly within Visual Studio for a more integrated development experience.

---

How to run with Kubernetes

Instructions for running TaskoMask with Kubernetes will be provided as soon as we complete the necessary configurations. We are actively working on this feature to enhance deployment options.