yaal/escut
yaal/escut
5
0
Fork 0
Code Issues 11 Pull requests 2 Projects 2 Releases Activity
(écu en gascon) Un logiciel qui fait le pont entre Canaille et un système de paiement pour gérer des abonnements.
311 commits 5 branches 0 tags 18 MiB
Find a file
Exact
Éloi Rivard 89b48a613b
All checks were successful
ci/woodpecker/push/lint Pipeline was successful
Details
ci/woodpecker/push/tests Pipeline was successful
Details
chore: move from pre-commit to prek
2025-08-26 09:21:39 +02:00
.woodpecker chore: move from pre-commit to prek 2025-08-26 09:21:39 +02:00
ansible chore: move ansible files at the top level 2023-12-22 15:17:43 +01:00
docs chore: project renamed to "escut" 2025-04-23 14:39:32 +02:00
tests refactor: refacto test_plans_display_logged 2025-07-17 09:37:04 +02:00
web refactor: grids are now flexbox and js menu snippet is fixed 2025-08-25 11:51:55 +02:00
.env.dist feat: make payment provider optional 2025-07-08 11:28:00 +02:00
.gitignore chore: attempt to use diff-cover 2025-07-08 17:01:59 +02:00
.gitmodules chore: add nubla theme to canaille 2023-12-22 18:12:37 +01:00
.pre-commit-config.yaml chore: pre-commit update 2025-08-21 10:25:48 +02:00
ansible.sample.cfg chore: do not version ansible.cfg 2023-08-29 14:13:27 +02:00
canaille.toml chore: Canaille users with the user_name 'admin' are admins 2025-06-25 19:02:15 +02:00
compose.yml feat: store canaille database and client credentials to avoid multiple registers 2025-07-08 11:42:24 +02:00
dev.toml feat: make payment provider optional 2025-07-08 11:28:00 +02:00
Dockerfile feat: docker container now autoreloads when changing code 2025-05-12 16:33:40 +02:00
Procfile feat: Lago now must be launched before main application, for various reasons 2025-04-18 16:01:14 +02:00
pyproject.toml chore: move from pre-commit to prek 2025-08-26 09:21:39 +02:00
README.md chore: move from pre-commit to prek 2025-08-26 09:21:39 +02:00
uv.lock chore: move from pre-commit to prek 2025-08-26 09:21:39 +02:00

README.md

Escut

Gestion des abonnements et paiements pour des services intégrant le protocole SCIM.

Installation

Pour installer l’environnement de développement, il est nécessaire d’avoir installé Docker, Docker Compose, git, uv et prek sur sa machine. Puis :

  • Installer les dépendances du projet :

    uv sync --all-extras --all-groups

  • Installer les crochets de prek :

    prek install

Environnement de développement

  • Générer un fichier .env : 
    cp .env.dist .env
  • Générer un fichier vide pour stocker la BDD Canaille : 
    touch canaille.sqlite
  • Démarrer les containers : 
    docker compose up
  • (Optionnel) Lier Lago à Stripe :
    • Décommenter l'entrée STRIPE_INTEGRATION_CODE dans votre fichier .env
    • Accéder à l'interface de Lago sur http://localhost
    • Se connecter avec l'email "admin@test.com" et le mot de passe "password"
    • Aller dans le menu "Settings" -> "Integrations"
    • Ajouter une intégration Stripe avec la clef API Stripe de test dans le Keepass. Le "connection code" doit correspondre à l'entrée STRIPE_INTEGRATION_CODE dans le fichier .env (par défaut, "sandbox")

L'application est accessible sur http://escut.localhost:4000

Documentation

  • Pour générer la documentation :
uv run playwright install firefox
cd docs
make html