Un projet de fin d'année en BDDI3 à l'école @Gobelins.
Pour faire tourner le projet en local, il vous faut:
- Cloner le dépôt
# SSH
git clone [email protected]:leoboyerbx/toodoo.git
# HTTPS
git clone https://github.com/leoboyerbx/toodoo.git
Ce projet est divisé en 3 parties: app mobile, jeu sur chromecast et serveur. Pour installer les dépendances des 3 dossiers à la fois, placez-vous dans le dossier racine et lancez le script setup
:
cd toodoo
yarn setup
cd mobile-app
Lancer le serveur de développement
yarn dev
Lancer le serveur de développement avec accessiblité depuis le réseau local (MacOS uniquement)
yarn dev:lan-mac
cd cast-app
Lancer le serveur de développement
yarn dev
💡 En environnement de développement, l'écran d'appairage n'existe pas: L'appairage est fait automatiquement aussitôt que les deux parties sont ouvertes dans un navigateur.
cd server
Démarrer les conteneurs Docker
yarn dk:start
Lancer le serveur de développement
yarn dev
ℹ Pour pouvoir fonctionner, le serveur de dv a besoin que les conteneurs tournent, donc
yarn dk:start
est indispensable avantyarn dev
Sinon, on peut démarrer les conteneurs puis directement lancer le serveur de dev:
yarn dk:dev
Arrêter les conteneurs (recommandé avant de terminer une session de travail)
yarn dk:stop
⚠️ L'arrêt des conteneurs efface la base de données si elle n'a pas été sauvegardée. La commande propose de sauvegarder avant l'arrêt des conteneurs.
Un utilitaire permet de sauvegarder et restaurer l'état de la base de données.
Sauvegarde:
yarn db:save
Restaurer une sauvegarde:
yarn db:load
Pour plus d'infos sur la structure, l'organisation ou le déploiement, voir le wiki.
Emoji | Description |
---|---|
🔧 | Add or update configuration files |
✨ | Introduce new features |
🐞 | Fix Bug |
📚 | Documentation (add or remove) |
🚨 | Test |
✅ | Adding test |
🔨 | Code refactoring |
🎨 | Improve format & structure |
🗑 | Removing code / file |
🔒 | Security |
🖌 | Lint |
⏪ | Reverting change |
💩 | Bad code / need to improve |
👌 | Code review changes |
📄 | Readme update or correction |
⬆️ | Upgrade dependencies |
⬇️ | Downgrade dependencies |
🧩 | Add Component |
🚧 | Work in progress |
🥞 | Database change |
🛣 | Adding a API Route |
🏗 | Changes to the CI construction system |
🚀 | Deployment stuff |
🤹 | Animation |
🏄 | Front end add or update |
🥷 | Back end add or update |
🍱 | Add or update assets |
💡 | Add or update comments in code |
- Léo Boyer alias @leoboyerbx
- JohannDumoulin Minguet
- Vincent Creton alias @cretonv
Retrouver les comptes github des contributeurs du projet.