Development Tools
This is a collection of scripts which facilitate the development process. They are targeted at as much platforms and configurations as possible, but there might be edge cases in which they don’t work as expected.
Installation
Install all project dependencies and the local python package with https://github.com/digitalfabrik/lunes-cms/blob/develop/tools/install.sh:
./tools/install.sh [--clean] [--pre-commit]
--clean
: Remove all installed dependencies in the.venv/
andnode_modules/
directories as well as compiled static files inlunes_cms/static/dist/
.--pre-commit
: Install all Pre-commit Hooks
Development Server
Run the inbuilt local webserver with https://github.com/digitalfabrik/lunes-cms/blob/develop/tools/run.sh:
./tools/run.sh [--fast]
Options:
--fast
: Skip migrations and translation on startup and just start Django
Translations
Perform makemessages
and compilemessages
in one step with https://github.com/digitalfabrik/lunes-cms/blob/develop/tools/translate.sh:
./tools/translate.sh
Resolve merge/rebase conflicts with https://github.com/digitalfabrik/lunes-cms/blob/develop/tools/resolve_translation_conflicts.sh:
./tools/resolve_translation_conflicts.sh
Check whether your translations is up-to-date with https://github.com/digitalfabrik/lunes-cms/blob/develop/tools/check_translations.sh:
./tools/check_translations.sh
Test Data
Import test data into the database https://github.com/digitalfabrik/lunes-cms/blob/develop/tools/load_test_data.sh:
./tools/load_test_data.sh
Documentation
Build this documentation with https://github.com/digitalfabrik/lunes-cms/blob/develop/tools/build_documentation.sh:
./tools/build_documentation.sh [--clean]
Options:
--clean
: Remove all temporary documentation files in thedocs/src/ref/
directory as well as the compiled html output indocs/dist
. Existing outdated documentation files can cause the generation script to fail if e.g. source files were added or deleted.