Skip to content

Getting started ​

Requirements ​

  • JDK 21
  • Docker and Docker Compose

Start the API ​

Docker or OrbStack, without a local JDK ​

Docker Desktop and OrbStack expose the same Docker Compose CLI:

bash
cp .env.example .env
docker compose --profile app up -d --build
docker compose ps
docker compose logs -f app

This starts PostgreSQL, Redis, and the Java application in containers.

Local Java development ​

bash
cp .env.example .env
docker compose up -d
./mvnw spring-boot:run

The API listens on http://localhost:8080. Check GET /actuator/health, open /swagger-ui.html, or fetch /v3/api-docs. The development administrator is admin / admin123; replace ADMIN_PASSWORD and JWT_SECRET outside local development.

Connect the frontend ​

From the fast-vue3 repository:

bash
VITE_FAST_VUE3_SERVER_URL=http://localhost:8080 pnpm dev:server
pnpm dev:site-antd

The browser always calls /api/v1; the shared Vite proxy selects the configured backend.

Documentation ​

The maintained server documentation is part of fast-vue3-site. The server repository intentionally contains no Node.js or VitePress toolchain.

Released under the MIT License.