These system dependencies are required, Linux OS is preferred.

Docker has to be able run as a non root user for more info check

Post-installation steps for Linux | Docker Documentation

If you are using Linux, put this into your bashrc .bashrc OR .zhsrc, it's needed for the file permissions.

export UID=$(id -u)
export GID=$(id -g)

1. Run this command, to setup the development environment

bash shscripts/setup_dev.sh

If you are using Windows you'll have to inspect shscripts/setup_dev.sh, and find the equivalent commands, or use the Linux Subsystem.

2. Load development command utilities with

source shscripts/dev.sh

3. Activate the backend server, to test if everything has worked

runserver

4. Activate the frontend server, to test if everything has worked

yarn dev

It is recommend to check the commands of shscripts/dev.sh it has a ton of useful commands.

If you want to source the commands

source shscripts/dev.sh

API REST documentation is located at

http://127.0.0.1:8000/api/docs

• Nextjs as the JS framework
• rsuiter as the UI component library

• Frontend i18n