- Clone the Distrochooser repository https://github.com/distrochooser/distrochooser important: branch main
- Clone the translation repository https://github.com/distrochooser/translations important: branch 6-new-baseline INTO the folder
locale
, e. g. withgit clone https://github.com/distrochooser/translations.git -b 6-new-baseline ./locale
Important: Make sure you've cloned the contents of the https://github.com/distrochooser/translations repository directly into the locale
folder. You can verify this if after the cloning your locale
folder should contain files like ui-en.json
, without having a new subdirectory "translations".
You should now see following folder structure:
[...]
code/
doc/
locale/ <-- this folder is from the translation repo and should contain JSON-files
HOW-TO-Map.md
[...]
We assume you use a venv-like approach here. If you use another approach, replace this step with the tool of your choice.
Create the venv:
python -m venv ./venv
while ./venv
is the path where you want to put the virtual environment folder into.
Activate the venv (this step depends on your operating system, see https://docs.python.org/3/tutorial/venv.html for details):
source ./venv/bin/activate
for unix-like Systems and .\venv\Scripts\activate
for Windows systems
Switch into the folder code/kuusi
and executing following command
pip install -r requirements.txt
# Create database (sqlite per default here) and migrate the structure
python manage.py migrate
# to get a user and password for the admin panel on /admin
python manage.py createsuperuser
# Import the base questionaire structure
python manage.py parse ../../doc/matrix/toml/matrix.toml --wipe
# Add static files
python manage.py collectstatic
At this point, you have a filled database and basically can start the application using python manage.py runserver
. You should now be able to open http://localhost:8000 and http://localhost:8000/admin, respectively.
If you plan to do CSS/ styling changes, you need to add the frontend requirements aswell. For all other purposes, the required files are included in the repository. See THIRD-PARTY-LICENSES.md for further information.
For this, switch into the design
folder and execute yarn install
. After that, you will be able to use yarn run build-styles
and yarn run build-js
. Both commands result in files being put into the folder ../static
.
See CONCEPTS.md for details about application structure.