Thank you for your interest in our project. Contributions are always welcome. Feel free to open an issue if you have any questions, ideas, or bugs to report, or submit pull requests to contribute code.
We are committed to fostering a welcoming, respectful, and harassment-free environment, so please be kind! 💖
Get credentials for public usage from Marketingportal and add them to your .env File - see .env.template.
npm install
# it should run postinstall tasks from @db-ux/db-theme* by default, if not:
# execute this tasks manually to decode the assets using the previously made setup:
npm run decode-db-theme-assetsIf you're contributing from a fork in your user space, please also set up those credentials from the Marketing portal in your fork repository as repository secrets. You need these credentials for the pipeline to decrypt the brand assets correctly.
Note
If you missed setting up the .env-file before running npm install, you may need to re-install your packages to ensure the postinstall scripts are executed for decrypting the fonts and other artifacts (rm --recursive --force node_modules/@db-ux/db-theme* && npm update @db-ux/db-theme)
npm run build
npm run devPlease ensure that Husky is installed correctly to validate your changes, e.g. by running npm run prepare in the codebase.
Please verify you are using a valid branch name as described by the pattern in your package.json in the section validate-branch-name.
Moreover, you need to duplicate .env.template as .env and type your own email address. This ensures that you have the correct email set for this project.
Please note that we have established code and git commit (message and branch naming) conventions, which are enforced using various linting tools.