73 lines (50 loc) · 1.66 KB

Local Development Setup

This guide covers how to set up Solid Fortnight for local development.

1. Prerequisites

Ensure you have the following installed:

Go: Version 1.25.0 or higher.
Docker & Docker Compose: For running infrastructure (PostgreSQL and Redis).
Bun: For dashboard development.
Bruno: For testing the APIs.

2. Initial Setup

Clone the Repository:

git clone https://github.com/adafia/solid-fortnight.git
cd solid-fortnight

Environment Variables: Copy the example environment file and load it:
```
cp .env.example .env
source ./scripts/env.sh load
```
Start Infrastructure:

Spin up the PostgreSQL and Redis containers:
```
make db-up
```

3. Running Services

You can run the microservices individually during development to see logs more easily:

Service	Command	Port
Management API	`make run-mgmt`	`8083`
Evaluator	`make run-eval`	`8082`
Analytics	`make run-analytics`	`8081`
Streamer	`make run-stream`	`8084`
API Gateway	`make run-gateway`	`8080`
Dashboard	`make run-ui`	`5173`

Running everything in Docker

To run the entire stack (all services + infrastructure) in Docker:

make start-all

4. Useful Commands

Run all backend tests: make test
Run dashboard unit tests: make test-ui
Run E2E tests: make test-e2e
Clean Docker: make clean

5. API Testing

We use Bruno for API exploration.

Open Bruno.
Import the collection from the bruno/ directory.
Select the Local environment.