This repository contains the source code of the web app for the mentorship social network, all of the current work can be tracked in a board located on Github Projects.
These system dependencies are required, Linux OS is preferred.
| System dependency | Version | Usage |
|---|---|---|
| bash | >= 5 | Setup scripts |
| docker | >= 24 | Build images |
| docker-compose | >= 2 | Development environment |
| pnpm | >= 8 | Manage Javascript deps |
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)Run the command below, to setup the development environment
bash ./shscripts/setup_dev.shAdd HTTPS certificate mkcert/rootCA.pem to your browser, please visit these webpages for the steps.
Load development command utilities with
source shscripts/dev.shActivate the servers, to test if everything has worked.
# Django
runserver# Vite
pnpm run devVisit https://127.0.0.1:8000 in your web browser.
It is recommend to check the commands of shscripts/dev.sh as it has a ton of useful commands.
If you want to source the commands
source shscripts/dev.sh- CI/CD is currently made with Github Actions and it is docker based.
- If you don't want a specific action it can be disabled.
Read this file Local production testing procedure