Developer Guide / Build & Run Locally

Build & Run Locally

Get the platform building and running on your machine.

Prerequisites

  • Java 17
  • Maven 3.9+
  • Docker and Docker Compose
  • Node 20 (downloaded automatically by the Maven build for frontend modules)

Building

# Build everything (backend + frontend + portlets)
mvn clean package -DskipTests

# Backend only (skip the React builds)
mvn clean package -DskipTests -Dskip.frontend=true

# A single service and its dependencies
mvn -pl magicvarsh-auth-service package -DskipTests -am

# All Docker images
mvn clean package -Pdocker -DskipTests

Running with Docker Compose

docker-compose up --build              # start the full stack
docker-compose up --build <service>    # rebuild a single service
docker-compose down                    # stop (keeps data)
docker-compose down -v                 # full reset incl. database volumes
docker-compose logs -f <service>       # stream logs

Default admin credentials in a fresh environment are admin / Admin@1234.

Verifying a running service via its Swagger UI.
Verifying a running service via its Swagger UI.

Running a service directly

cd magicvarsh-auth-service
mvn spring-boot:run

Frontend dev server

For iterative frontend work, run the Vite dev server instead of going through Maven — it proxies /api to the gateway and gives you hot reload.

cd magicvarsh-frontend
npm install
npm run dev      # http://localhost:5173

Running tests

mvn test                                       # all modules
mvn -pl magicvarsh-auth-service test           # one service
mvn -pl magicvarsh-auth-service test -Dtest=AuthServiceTest#login