Some of this project's code is in Dutch (commit messages, documents etc.), along with the whole website. This was originally a school project, but I'm going to keep maintaining this project during my exams and summer break
A design prototype of the website can be found on Figma. The api documentation can be found in api/readme.md.
To set up this project you'll need to install npm and pip dependencies, pull all git submodules and compile voerbak and the sql extensions.
I haven't figured out how to run this project on Windows, so please install WSL if you want to run this yourself on Windows. The distro you choose doesn't matter, though package names in ./config may vary if your distro doesn't use the apt package manager.
./config
(debian/ubuntu)This script might also work on other distro's using the apt
package manager.
To start the setup process you only need to run the following command:
./config
The script calls sudo and apt install so some password input/manual confirmation is required, but most of the install should be automated.
If your disto doesn't use the apt
package manager, you can still run this
project by following these steps:
git clone https://github.com/lonkaars/po-4-op-een-rij
./config yarn_install
./config python_packages
./config node_packages
./config voerbak
./config submodules
./config database
In order to start this project you'll need three terminal windows to start the flask server, react server, and nginx seperately:
# term 1
cd api
../venv/bin/python3 main.py
# term 2
yarn dev
# term 3
sudo nginx -c $PWD/nginx.conf
# if nginx can't run as the user nobody, try running the following command and restart nginx:
./config customize_config