• docker v20.0+
• docker-compose v2.12+
• If you're running from Windows, you should have WSL installed (it's already installed with Docker Desktop by default) to be able to run shell scripts.

1. Change your working directory to project root
2. Create your own .env file. You should set your own HMAC_SECRET and DB_PASSWORD. Other params may also be changed. You may take example from .env.example.
3. Run shell script that is located at build/build_and_up.sh without any params. Remember that your working directory must be the project root.
4. After services started run the migration script to initialize db schema:

docker exec companies-api /app/migrate

5. You may import Postman collection at tests/postman-collection/companies-test-task.postman_collection.json for testing.
6. After finishing testing run shell script build/down.sh to stop and delete all containers.

• LISTEN_ADDR socket address that companies service will listen at. Default is :8080;
• HMAC_SECRET is used for signing/verifying JWT tokens. Empty by default;
• DB_HOST must point to Postgres IP address. Default: localhost;
• DB_PORT must point to Postgres port. Default:5432;
• DB_USER is Postgres username. Default: companies;
• DB_PASSWORD is Postgres password. Empty by default;
• DB_NAME is the database name. Default: companies;
• DB_MIGRATIONS - relative path to migration scripts. Default: db_migration.

There is a tiny auth "service" at :8090 that has only one endpoint GET /login which signs new JWT token with configured HMAC_SECRET. This JWT token then passed to CRUD endpoints on companies service. There is no login/password prompt for simplicity purpose - just a new valid JWT token.