Getting started

You can run Code Metrics in a number of ways:

• Docker or Docker Compose
• AWS Lambda
• Kubernetes
• Using Node.js directly

Once you have chosen an approach, continue to the configuration guide.

---

Docker Compose

This method uses Docker Compose.

To start, clone the repository then run:

docker compose -f compose/docker-compose.yaml --project-directory . up --build

Note: if you want to run with mocked backend services, amend the Compose command as follows: docker compose -f compose/docker-compose.yaml -f compose/docker-compose-mocks.yaml --project-directory . up --build

Access:

• Access the web UI at http://localhost:3001
• The API runs at http://localhost:3000

Note To change the config path, set the CONFIG_DIR environment variable.

For example: CONFIG_DIR=/path/to/config/files docker compose compose/docker-compose.yaml --build --project-directory . up

AWS Lambda

Code Metrics can be deployed to AWS Lambda.

See the AWS Lambda deployment instructions.

Kubernetes

The Code Metrics Docker containers can also be run on Kubernetes.

See the instructions for using Helm.

Using Node.js directly

See the Node.js deployment instructions.

---

Next steps

Learn how to configure Code Metrics for your team.