espoon-voltti / evaka

eVaka® – ERP for early childhood education This is eVaka® – an ERP system developed for early childhood education in Finland. It is a web application developed using modern technologies and designed to be deployed in cloud environment. eVaka® is governed, funded and primarily developed by Espoo, Oulu, Tampere and Turku (4pack). The roadmap and architecture are driven by the needs of these deployments and their early childhood education processes. Other municipalities and private entities may deploy eVaka in production, but the core development team may be unable to provide implementation or operational support for third parties. Plan to run and maintain your deployment yourself or with a partner. Before opening an issue, consider whether your need can be met by harmonizing your early childhood education processes with existing eVaka municipalities. Municipality-specific deviations may not fit the shared product direction and are less likely to be included in core eVaka®. See CONTRIBUTING.md for contribution guidelines. How to get started For development purposes, the application can be run locally on your development machine. See further instructions in the README file of the directory. The applications consists of several sub-projects: • – API gateway, responsible for handling authentication and routing requests to backend services • – User interfaces for the citizens and employees, and Nginx image for proxying frontend requests to services • – All the business logic, e.g. handling early childhood education application process and daily work in daycare • – Tooling for running application in local development environment, using e.g. Docker • – Old common library for service projects, but today only used by . and a few other important directories: • – Helper shell scripts • – General eVaka® documentation • – Shared BOM for eVaka® Gradle projects, for easier dependency updates and control Contributing Please refer to CONTRIBUTING.md for further instructions regarding code contributions. Running CI for forked Pull Requests **After** the code in a forked PR has been reviewed to not pose a security risk for CI: In CircleCI, "Build forked pull requests" must be enabled for repository. **IMPORTANT:** "Pass secrets to builds from forked pull requests" must still be **disabled**. After the push the build in the original PR continues. Once it passes, merge the branch. If any changes are made to the PR, they must similarly pushed to origin. You can use the same method as above. Security issues In case you notice any information security related issue in our services, or you have an idea how to improve information security, please contact us by email at evakatuki@espoo.fi License eVaka® 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 and the REUSE API. The REUSE API constantly checks this repository's compliance and the status can be seen from the badge at the top of this README. To manually check that the repository is compliant (e.g. before submitting a pull request), run: **NOTE:** The tool has no concept for "no license" -> all files must indicate their license explicitly (or using bulk licensing). And if files cannot be licensed, they shouldn't be included in this repository at all. Automatically add licensing headers To attempt automatically adding licensing headers to all source files, run: Linting shell scripts CI does this automatically but you can manually lint all the shell scripts in this repo with: . See shellcheck for more details on the linter. Contact information eVaka® is developed in the City of Espoo, Finland. You can contact the development team at voltti@espoo.fi.