Main goal of the project to manage and share loyalty card for various shops.
Currently project roadmap can be found here: Roadmap
To access technical documentation and API documentation use
root
Test12345
For local development you will need:
- Python 3.13.0
- Node 20.11.1
- Yarn 4.5.0
- Go/task
- Docker
This project use taskfile
to organize some of the most common commands/scripts for local development and production deployment. Commands can be found in taskfile.yml
file, for example:
task up.dev // start compose.dev.yml
task deploy // used on server to deploy latest changes
task manage -- //followed by command that will be redirected to django manage.py
I'm using compose.slim.yml to run the project on bare metal homelab server, with couple of key things:
- Each pet project have a separate port that is provided by
SERVICE_PORT
env variable - Caddy don't manage SSL certificates, i'm using cloudflare tunnel to manage DNS A records and host service behind strict NAT environment
For anyone who wants a try in on separate vm instance please use regular compose.yml