Contribuer au projet
Guide pour contribuer à Aurora Home — que ce soit sur l'application web Next.js ou le firmware ESP32.
Deux dépôts indépendants
Le projet Aurora Home est composé de deux dépôts Git séparés : aurora-home-app (application Next.js) et aurora-home-esp32 (firmware PlatformIO). Les contributions peuvent cibler l'un ou l'autre indépendamment.
Workflow de contribution
Forker le dépôt
Forkez le dépôt correspondant sur GitHub depuis votre compte.
git clone https://github.com/VOTRE_USERNAME/aurora-home-app.git
cd aurora-home-appCréer une branche feature
Créez une branche avec un nom descriptif depuis main :
git checkout -b feature/ma-fonctionnalite
# ou
git checkout -b fix/correction-bug
git checkout -b docs/mise-a-jour-docDévelopper en respectant les conventions
Suivez les conventions de code du projet :
- App Next.js : Biome pour le linting, kebab-case fichiers, PascalCase composants
- Firmware ESP32 : snake_case fonctions, UPPER_SNAKE_CASE constantes
- TypeScript strict — pas de
anyexplicite - Logique métier dans des usecases — pas directement dans les Server Actions
Vérifier le code
Avant de soumettre, vérifiez que le code passe toutes les validations :
# Linting + formatting
npx biome check .
# Tests unitaires
npm run test
# Build de vérification
npm run build# Compilation PlatformIO
platformio run -e esp32devCréer une Pull Request
Poussez votre branche et ouvrez une PR sur GitHub :
git add .
git commit -m "feat: description courte de la fonctionnalité"
git push origin feature/ma-fonctionnaliteDans la PR, décrivez :
- Le problème résolu ou la fonctionnalité ajoutée
- Les tests effectués
- Screenshots si changement visuel (App)
Contributeurs
Personnes ayant contribué aux dépôts de l'organisation ESP-AuroraHome sur GitHub.
MSc2 - Epitech Rennes (promo 2026)
Développeur full stack | TypeScript, React, Next.js, Node.js | Créateur d’outils web et SaaS
Setup environnement de développement
aurora-home-app
npm install
npx prisma db push
npm run dev # http://localhost:3000aurora-home-esp32
# Ouvrir platformio_IDE/ dans VS Code avec l'extension PlatformIO
# Build : Ctrl+Alt+B
# Upload : Ctrl+Alt+U
# Monitor : Ctrl+Alt+Saurora-home-marketing
npm install
npm run dev # http://localhost:5173