Skip to content

getting-started.md

Latest commit

 

History

History
57 lines (38 loc) · 1.27 KB

getting-started.md

File metadata and controls

57 lines (38 loc) · 1.27 KB
Raw

Getting Started

Prerequisites

  • Java 21
  • Node.js >= 20
  • Docker & Docker Compose

Running the application

All commands below should be run from the project root directory.

1. Configure environment

Copy .env.properties.example to .env.properties and fill in the required values.

2. Start Docker dependencies

Make sure Docker is running, then start the required services:

./gradlew :backend:app:composeUp

3. Start the backend

./gradlew :backend:app:bootRun

4. Start the frontend

cd frontend
npm install
npm run libs-build-all
npm start

Keycloak users

The application has a few test users that are preconfigured.

Name Role Username Password
James Vance ROLE_USER user user
Asha Miller ROLE_ADMIN admin admin
Morgan Finch ROLE_DEVELOPER developer developer

Plugin development

The plugin source code is located in:

  • Backend: backend/plugin/src/
  • Frontend: frontend/projects/plugin/src/

For more information on how to build a plugin, see the Custom Plugin Definition documentation.