Skip to content

HomeLabHQ/loyalist

Repository files navigation

LinkedIn
TimeSpent Coverage Technical Debt Maintainability Rating Security Rating Duplicated Lines (%) Ruff

Project description

Main goal of the project to manage and share loyalty card for various shops.

Project status

Currently project roadmap can be found here: Roadmap

Documentation

To access technical documentation and API documentation use

root
Test12345

Documentation

API Docs

Main technologies

python django celery typescript react react-router redux vite mantine

Prerequisites

For local development you will need:

  • Python 3.12.1
  • Node 20.11.1
    • Yarn 4.5.0

Also strongly recommend using tools like nvm and pyenv for running specific versions of Python and Node for this project

NOTE: Additionally install poetry self add poetry-dotenv-plugin to auto load env variables in shell and run command

Current production environment

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