Project CT

TBD

Requirements

This project requires the following to run locally:

• Make
• Docker compose v2.2.1+

Install Docker Compose

For Linux you can install docker compose directly For Windows it is recommend to use wsl2 and follow the linux instructions. Otherwise you can install the desktop version. On Mac you must install docker desktop as it is the only way to get docker compose (as of this writing).

See the docker compose install page for the latest information.

Install Make

Linux installation

Mac installation via homebrew

Development

If using docker desktop you must have the application open for the below command to work.

The project Makefile provides a central entrypoint for interacting with the project.

To get started simply run: make env && make all

Refer to the Makefile for further commands

Note: if you run into any issues with port 5000 on mac, this stackoverflow post may help.

Next

• For API development, refer to the API documentation
• For Web development, refer to the Web documentation
• For Operations development, refer to the Operations documentation