tamagokill

Tamagochi, mais version Mirror universe ; Le but n'est pas de le tenir en vie, mais de le tuer. Projet open-source avec la communauté sur Twitch. Pour fêter les 4k followers.

Roadmap

• Protection du repo Github
• Créer le Wiki - Doc technique
• Mise en place semver et Conventional Commits dans Git flow
• Mise en place du monolithe
• COC (Code of Conduct)
• Mise en place des templates pour Issues
• Mise en place de la doc avec Docusaurus
• Ajout CONTRIBUTING.md
• Intégrer le crate (code + doc) du générateur de tamago sprite
• Ajout d'un manuel pour les ADR dans CONTRIBUTING.md
• Hosting (Shiftek ou Vercel ?)
• Transformer les fichiers de config en tables d'authorité
• CI/CD
• Lancement du projet en prod

La stack

• Client Web - SvelteKit
• API - Axum
• DB - PostgreSQL

Features du projet

Getting started

Manually

API

cargo run

Web

npm install
npm run dev

Docker

Dev environment

docker compose -f compose.dev.yaml up --build --watch -d

Production environment

docker compose up -d

Dev shell nix

Si vous utilisez nix (Linux ou MacOS), vous pouvez utiliser le shell de développement pour avoir un environnement de développement cohérent.

Dans votre terminal, à la racine du projet, exécutez:

nix-shell

Si vous avez activé les flakes, vous pouvez aussi exécuter:

nix develop