Skip to main content

Run the system locally

Prerequisites​

ComponentDevelopment requirementsUsual local port
FrontendNode.js, npm; Angular 19 project4200
BackendJava 21, Maven, configured MariaDB8080
PrintPHP 8.3+, Composer; ZIP, DOM, FTP and database extensions3000
These docsNode.js 20+, npm3001

Use the versions declared in each repository and its lockfile. Documentation examples do not provide database or integration credentials.

Spring backend​

The Maven reactor contains common-313, repository-313, mapper-313, service-313, exception-313, and web-313.

cd tuition-backend
./mvnw -pl web-313 -am package -DskipTests
java -jar web-313/target/web-313-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev --spring.batch.job.enabled=false

Select the development profile explicitly: main-deploy keeps production defaults. Configure the development datasource before starting. Flyway validates and applies pending migrations during startup.

Automatic batch execution is disabled in this example. Monthly generation is a separate operation.

Angular frontend​

cd tuition-frontend
npm ci
npm start

Review src/environments/environment.ts for the backend and print origins. Production uses environment.prod.ts. The print URL currently targets the deployed Laravel service; change it to http://localhost:3000 only when deliberately using a local print instance.

Authentication configuration depends on the environment. The frontend uses Keycloak integration; do not assume that a disabled local login configuration secures a deployed API.

Laravel print service​

cd tuition-print
composer install
cp .env.example .env
php artisan key:generate
touch database/database.sqlite
php artisan migrate
php artisan serve --port=3000

Configure BACKEND_URL, template storage, Google conversion, SMTP, Telegram, and the shared PRINT_WORKER_TOKEN through local environment files. Never copy them into the docs or Git.

For isolated checks, php artisan test fakes integrations. php artisan print:render-sample renders the bundled DOCX sample without sending an invoice.

Documentation preview​

cd tuition-docs
npm ci
npm start

Use npm run build followed by npm run serve to preview the production build, including its generated local search index.