English version // Deutsche Version
Welcome to the Kiebitz project! Please visit our website to learn more about us.
Kiebietz consists of three apps for providers, mediators and users, which can be reached under /provider, /mediator and /user, respectively. The app can be built with different environments:
- The
devenvironment works against a locally deployed backend and is great for testing the apps against a real backend. - The
productionenvironment build the app bundles for production deployment, i.e. minified and optimized code that works against the production backend.
To run the app in dev mode, simply run
npm run-script build-devafter running npm install. To build the dev and production versions simply run
# build the development version
npm run-script build-dev
# build the production version
npm run-script buildWe use eslint and prettier for linting and formatting of code. To lint code, run
# just lint
npm run-script lint
# lint and autofix where possible
npm run-script lint-fix
# lint SCSS
npm run-script lint-scss
# lint and fix SCSS where possible
npm run-script lint-scss-fix
# format code
npm run-script prettierYou can run the bundle size analyzer (which helps you to identify packages and assets taking up a lot of space in the bunde) via
npm run-script analyzeThe Kiebitz software code is licensed under Affero GPL version 3 (AGPL-3.0). Please see the license file for more information. The license was chosen to ensure that any changes to Kiebitz will benefit the community.
Documentation is licensed under the Creative Commons - Attribution ShareAlike 4.0 International license. Please see the license file for more information (translated license texts can be found at the link above).
If you have any questions just contact us.
We are happy about your contribution to the project! In order to ensure compliance with the licensing conditions and the future development of the project, we require a signed declaration of consent for all contributions in accordance with the Harmony standard. Please sign the corresponding document for natural persons or for organizations and send it to us.
We use the following third-party libraries and assets directly in this codebase (in addition to the ones specified in package.json and requirements.txt):
Did you find a security issue you'd like to report? Please contact us at [email protected]. We appreciate if you follow responsible disclosure practices. Please do not create a public Github issue for exploitable vulnerabilities that you've identified. We do not have a formal bug bounty program in place but will try to reward researchers for significant security findings. We also pledge to never take any kind of legal action or retaliate against researchers that disclose security issues in good faith. You may of course disclose issues anonymously as well.