artisan-trace

This application uses Docker Compose for managing its services. This document provides instructions on how to set up, run, and manage the application using the provided Makefile.

Prerequisites

Ensure the following software is installed on your system:

• Docker
• Docker Compose
• Make
• Node (Recommended LTS Version) To verify if Node.js is installed run:

node --version

If not installed, download if from the official Node.js Website or install it using packaged manager of your choice.

• Nix (optional, for environemnt management)

Getting Started

The Makefile provided simplifies common Docker Compose commands. Below is a guide on how to use it.

1. Starting the Application

To start the application and its associated services:

Starting the application (services)

make up

Stoppping the application (services)

make stop

Stoppping and Removing containers

make down

Build the application

make build

Viewing Logs

make logs

Clean Up

make clean

Syntax Check

make check-syntax

Help Command

make help

Additional Notes

• All commands are aliases for docker-compose commands, so feel free to use Docker Compose directly if preffered

• Ensure Docker and Docker Compose are propertly installed and running before using the above commands

Nix

Optional Setup

This application provides a nix configuration (flake.nix, shell.nix and .envrc) for setting up a reproducable development environment. While nix is not required, it can signifantly simplify dependency management and development setup.

1. Install Nix Follow the instructions here to install nix on you machine

2. Enable Direnv If you have direnv installed, the .envrc file will automatically load the nix shell when you navigate to the project directory

   • Install .direnv from direnv.net
   • Allow the .envrc file in the project directory

     direnv allow

3. Activate the nix Shell Manually If you prefer not to use direnv, activate the nix shell manually by running:

   nix develop

4. Run Commands in the nix Environment Once the shell is active, all required dependencies for the project will be available. You can then proceed to use make, docker-compose, or npm commands as usual.