docker
Realistically, you really only need the docker cli. Docker makes development and production easier and more reproducible between environments.
docker compose up --build # Starts the project... but so does "just start"sudo pacman -S extra/docker # On arch
# Or
sudo pacman -S yay && yay -S extra/dockerIm like 99% sure the bottom one will always work... not sure about the top one
siblink
A custom built python package linker to make our jobs just a little bit easier. Instead of running scripts with python, we'd use the siblink wrapper like so
siblink run main.py pip install siblink
# Or
pip install pipx && pipx install siblink # On linux machines this is best, especially archTo be honest, we probably won't have to ever directly work with siblink unless something catastrophic happens but siblink has some useful commands for managing the python environment so its a good to have.
just
Command runner... its just easier.
just start # That simple.... as long as you have docker installednpm i -g rust-justRun just -l in the terminal to view them
Everything needed to know to configure different parts of this application. Most of it should be in yaml format but some of it especially credentials will be in a .env file. But other things that are only used in the backend will be in yaml format
This project requries a config.yaml file to be present. this file dictates most of the function of the backend so its crucial. Take from config.example.yml
Expand
Routing configuration options
APP_DOMAIN
Domain used throughout the application, mainly useful in development. recommended values include:
- 127.0.0.1.nip.io
- localdev.com only if you setup dnsmasq and don't mind certain... issues
- actualdomain.xyz for production only
Expand
Backend configuration options
Frontend
Frontend configuration options