Allu

Allu is a system to manage public area usage in Helsinki. It is used to handle, grant, monitor and manage rights and notifications to use the public areas. Billing for using the area is also handled via Allu.

Governed public areas include:

• street
• sidewalk
• the bike path
• green area work
• an event to be organized
• land for rent

It is recommended to open Allu project into three projects when you develop: backend, frontend and deployment.

• Node.js 16
• Java 17
• Maven 3.9.6 or newer version
  • add settings.xml file to path ~/.m2/. Example and artifactory credentials: https://helsinkisolutionoffice.atlassian.net/wiki/x/BwC72QE
  • add toolchains.xml file to path ~/.m2/. Example down below.
• Docker
• wkhtmltopdf

Example of toolchains.xml file. Change <jdKHome> path to where your designated version of Java 17 is. In Windows use two backslashes in the path \\.

<?xml version="1.0" encoding="UTF-8" ?>
<toolchains>
    <!-- JDK toolchains -->
    <toolchain>
        <type>jdk</type>
        <provides>
            <version>17</version>
        </provides>
        <configuration>
            <jdkHome>path/to/java/jdk</jdkHome>
        </configuration>
    </toolchain>
</toolchains>

You need to install wkhtmltopdf and set it in backend/pdf-service/src/main/resources/application.properties

Current version of wkhtmltopdf in use can be found in deployment/roles/backend_build/files/pdf_service_docker/wkhtmltox-version_linux-generic-amd64.tar.xz

1. Open application.properties
2. Change pdf.generator to point where you installed wkhtmltopdf

pdf.generator=/opt/local/wkhtmltox/bin/wkhtmltopdf

For database, you need to install Docker. Docker will start up PostgreSQL and Elasticsearch for the project. Below commands has been done in Linux environment.

Linux users need to increase max virtual memory for Elasticsearch. Edit file /etc/sysctl.conf by putting row: vm.max_map_count=262144

Start the database and Elasticsearch:

cd deployment/roles/database_build/files/database_docker
docker compose up

Database can be started without Elasticsearch with command:

docker compose up allu_database

If you encounter a problem where locale.md cannot be found, try temporarily changing the code below in the Dockerfile. This will work as long as there is only one locale setting.

Error:

[allu_database 7/9] RUN cat locale.md | xargs -i /usr/glibc-compat/bin/localedef -i {} -f UTF-8 {}.UTF-8:
': No such file or directoryinition file `fi_FI

Temporary solution: RUN cat locale.md | xargs -i /usr/glibc-compat/bin/localedef -i {} -f UTF-8 {}.UTF-8 -> RUN /usr/glibc-compat/bin/localedef -i fi_FI -f UTF-8 fi_FI.UTF-8

Go to backend folder:

cd backend
mvn install

Start backend with Docker:

docker compose up

Bare minimun is to start 4 services:

• allu-ui-service
• model-service
• search-service
• external-service

Starting class for each service can be found inside /src/main/java/

If you want swagger to work you need to start:

• supervision-api
  URL to swagger: http://localhost:9040/api-docs/swagger.json

Go to frontend folder, install dependencies and start frontend:

cd frontend
npm install -g @angular/cli
npm install
npm run start

Optional - if you want hot reload, run: npm run hmr

When you have database, backend and frontend running you can access to site from localhost:3000/login

Username: allute

The frontend is gated by GitHub Actions — see .github/workflows/frontend-ci.yml ("Frontend CI"). It runs on every pull request and on pushes to master and release-* branches, and consists of two parallel jobs:

• Lint — npm ci + npm run lint (must report 0 problems; the ESLint burn-down is complete).
• Build & Test — npm ci + npm run build + headless unit tests. Chrome is installed from the official Google .deb via apt (apt-get install -y google-chrome-stable deb, which resolves the runtime shared libraries), CHROME_BIN is set from command -v google-chrome, and tests run under a ChromeHeadlessNoSandbox Karma launcher (--no-sandbox — required when running headless Chrome as root, e.g. inside containerized CI like act; harmless on GitHub's non-root runners). See frontend/karma.conf.js.

Both jobs run on ubuntu-latest with Node 22.20.0 (matching the dev environment; npm cache keyed on frontend/package-lock.json).

From the frontend/ directory:

npm ci
npm run build
npm run lint
CHROME_BIN=/path/to/chromium npm test -- --watch=false --browsers=ChromeHeadless

To make the CI a merge gate for master, configure branch protection in GitHub UI:

1. Repository → Settings → Branches → Add branch protection rule.
2. Branch name pattern: master (add a separate rule for release-* if desired).
3. Under "Require status checks to pass before merging", select the checks Lint and Build & Test (these are the job names in the workflow above) and require them to pass on PRs.

This setting lives in GitHub's UI only — it cannot be committed to the repository.

This project is licensed under the MIT License - see the LICENSE file for details.