Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 3.15 KB

README.md

File metadata and controls

96 lines (64 loc) · 3.15 KB
Raw

eVakaTurku

eVakaTurku aka eVaka Turku – ERP for early childhood education in Turku.

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

Getting eVakaTurku dev environment up and running

Prerequisites - needed software and tools

See eVaka README

Starting eVakaTurku dev environment

  1. cd compose
  2. docker-compose -f docker-compose-dbs.yml up -d --build
  3. pm2 start (starts all apps)
  4. Open browser: http://localhost:9099/

Running eVakaTurku frontend tests

e2e (Playwright):

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

For WSL users:

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

Submodules

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

License

eVakaTurku 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:

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

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

NOTE: The tool has no concept for "no license", so currently it will always fail for the following files:

Automatically add licensing headers

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

./bin/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:

$ ./bin/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