Valtimo is the low-code platform for Business Process Automation. Our goal is to make implementing business process automation and case management easy.
- Valtimo consists of two services:
- A Spring Boot Java/Kotlin backend
- An Angular frontend
- Valtimo depends on two services:
- Keycloak as an identity and access provider
- A database (default is PostgreSQL)
This repository contains:
- A collection of Angular libraries that together form the Valtimo frontend.
- The
appmodule, containing an Angular application, used for library development.
Starting up the Valtimo platform requires three steps:
- Starting the supporting Docker containers: Keycloak and PostgreSQL. Instructions for starting the supporting services can be found here.
- Starting the Valtimo backend. Instructions can be found here
- Starting the Valtimo frontend. Instructions can be found here
- Install
nvm. More information can be found here - Install Node v20:
nvm install 20 && nvm use 20
Run the following command to install the dependencies: npm install.
Run the following command to build all the Valtimo libraries: npm run libs-build-all.
- Run the following command to start the Angular application:
npm start. - When this command has been completed, navigate to
http://localhost:4200/
When making changes to the libraries, the modified libraries have to be rebuilt. The following
command can be used to build one specific library: npm run libs:build:libraryName. Note: it is
possible to watch for changes in a specific library, building it automatically after a change has
been saved. For rebuilding automatically use the following command:
npm run libs:watch:libraryName.
The app will automatically reload if you change any of the source files.
To run TSLint on a specific library, run npm run libs:lint:libraryName.
Valtimo uses Prettier to format its code. Run the prettier:check command to check for formatting
errors, and prettier:write to automatically fix any errors.
We advise to configure your IDE to automatically format files on save.
- For IntelliJ IDEA please refer to this page.
- For VS Code you can refer to this guide.
Please make sure your code conforms to the project's Prettier code formatting rules before raising a Pull Request.
Run the following command to run the unit tests: npm run libs:test:libraryName.
Contributions are welcome! To get you in the right direction, please consult the Valtimo documentation for guidelines on how to contribute.
For contributing code, please refer to the coding guidelines.
For more information on what branches to create while working in this project, please refer to this page.
The source files in this repo are licensed under the EUPL 1.2. If you have any questions about the use of this codebase in a larger work: please reach out through the Valtimo website.
- Website: https://www.valtimo.nl
- Documentation: https://docs.valtimo.nl