Skip to content

Development Setup

  • JDK 21+
  • Node.js 20+
  • Docker (for PostgreSQL)
Terminal window
git clone https://github.com/plugwerk/plugwerk.git
cd plugwerk
docker compose up -d postgres
./gradlew build
Terminal window
./gradlew :plugwerk-server:plugwerk-server-backend:bootRun

The server starts at http://localhost:8080.

Terminal window
cd plugwerk-server/plugwerk-server-frontend
npm install
npm run dev

Vite dev server runs at http://localhost:5173 and proxies API requests to the backend.

Terminal window
# Backend (all modules)
./gradlew build
# Frontend
cd plugwerk-server/plugwerk-server-frontend
npm run test:run
LanguageCheckFix
Kotlin./gradlew spotlessCheck./gradlew spotlessApply
TypeScriptnpm run lintnpm run lint -- --fix

Always run the formatter before committing.