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
  

• Créer un compte administrateur dans Canaille

  docker exec escut-canaille-1 sh -c "canaille create user --user-name admin --password admin --formatted-name 'George Abitbol' --emails admin@mydomain.example --given-name George --family-name Abitbol"
  

• (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")
  • renseigner la clé dans STRIPE_API_KEY du .env

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

Mettre à jour l'image docker

docker build -t yaalcoop/escut:0.1.X -f ./Dockerfile-prod .
docker image push yaalcoop/escut:0.1.X

En remplaçant le X par la dernière version (il faut incrémenter à chaque mise à jour de l'image).