treVaka

treVaka aka eVaka Tampere – ERP for early childhood education in Tampere

This repository contains the code for customizing, configuring and extending the Espoo eVaka ERP for use in Tampere early education.

Checkout

treVaka utilizes the eVaka as its submodule. When cloning the repository use --recurse-submodules or manually initialize and update the submodule after cloning with git submodule update --init.

Getting treVaka dev environment up and running

Prerequisites - needed software and tools

See eVaka README

Frontend customizations must be linked under eVaka-repository:

cd frontend
./link.sh

It is also recommended to exclude folders under frontend so that files don't show twice after linking, e.g. Intellij IDEA: select all folders under frontend -> Mark Directory as -> Excluded.

Starting treVaka dev environment

1. docker-compose up -d --build
2. pm2 start or mise start (starts all apps)
3. Open browser: http://localhost:9099/

You can also start other supported configurations with --env command line parameter, e.g.:

pm2 stop all
pm2 start --env vesilahti
pm2 stop all
pm2 start # starts vesilahti configurations from previously used --env parameter
pm2 delete all
pm2 start # starts tampere configurations (default)

or with mise: mise start --env vesilahti.

Running treVaka frontend tests

e2e (Playwright)

1. Start treVaka dev environment
2. cd e2e
3. yarn e2e-playwright

For WSL users:

Install a tool for running X Window System, eg. GWSL.

Local test environment

It is also possible start test environment locally with just Docker Compose:

1. docker compose --profile evaka up --build
2. Open browser: http://localhost:9099/

You can also start other supported configurations with EVAKA_CUSTOMIZATIONS environment variable, e.g.:

EVAKA_CUSTOMIZATIONS=vesilahti docker compose --profile evaka up --build

License

treVaka is published under LGPL-2.1-or-later license. Please refer to LICENSE for further details.

Bulk-licensing

Bulk-licensing is applied to certain directories that will never contain anything but binary-like files (e.g. certificates) with a DEP5 file (see docs).

Check licensing compliance

This repository targets REUSE compliance by utilizing the reuse CLI tool.

To check that the repository is compliant (e.g. before submitting a pull request), run:

./add-license-headers.sh --lint-only

# See also:
./add-license-headers.sh --help

Automatically add licensing headers

To attempt automatically adding licensing headers to all source files, run:

./add-license-headers.sh

NOTE: The script uses the reuse CLI tool, which has limited capability in recognizing file types but will give some helpful output in those cases, like:

$ ./add-license-headers.sh
usage: reuse addheader [-h] [--copyright COPYRIGHT] [--license LICENSE]
                       [--year YEAR]
                       [--style {applescript,aspx,bibtex,c,css,haskell,html,jinja,jsx,lisp,m4,ml,python,tex}]
                       [--template TEMPLATE] [--exclude-year] [--single-line]
                       [--multi-line] [--explicit-license]
                       [--skip-unrecognised]
                       path [path ...]
reuse addheader: error: 'frontend/packages/employee-frontend/src/components/voucher-value-decision/VoucherValueDecisionActionBar.tsx' does not have a recognised file extension, please use --style, --explicit-license or --skip-unrecognised