Guide Day 1 - Setup Local
Audience : Nouveaux dĂ©veloppeurs rejoignant lâĂ©quipe
Durée estimée : 2-4 heures
Prérequis : Sprint 0 terminé
1. Prérequis
Section titled â1. PrĂ©requisâ1.1. Outils requis
Section titled â1.1. Outils requisâ| Outil | Version minimale | Installation |
|---|---|---|
| Node.js | 20+ | https://nodejs.org/ |
| Git | 2.30+ | https://git-scm.com/ |
| VS Code | DerniĂšre | https://code.visualstudio.com/ |
| Wrangler CLI | DerniĂšre | npm install -g wrangler |
| Sanity CLI | DerniĂšre | npm install -g @sanity/cli |
1.2. Comptes requis
Section titled â1.2. Comptes requisâ- Compte GitHub avec accĂšs au repository
- Compte Cloudflare avec accĂšs au workspace
- Compte Sanity avec accĂšs au projet
2. Clonage du repository
Section titled â2. Clonage du repositoryâ# Cloner le repositorygit clone git@github.com:votre-org/votre-repo.git
# Se déplacer dans le dossiercd votre-repo
# Installer les dĂ©pendancesnpm install3. Configuration des variables dâenvironnement
Section titled â3. Configuration des variables dâenvironnementâ3.1. CrĂ©ation du fichier .env
Section titled â3.1. CrĂ©ation du fichier .envâ# Copier le fichier d'exemplecp .env.example .env3.2. Remplir les variables
Section titled â3.2. Remplir les variablesâSANITY_PROJECT_ID=your-project-idSANITY_DATASET=productionSANITY_API_READ_TOKEN=your-read-tokenSANITY_API_WRITE_TOKEN=your-write-tokenSANITY_PREVIEW_SECRET=your-preview-secret
CLOUDFLARE_ACCOUNT_ID=your-account-idOĂč trouver ces valeurs :
SANITY_PROJECT_ID: Dashboard Sanity â Settings â APISANITY_DATASET:productionoustagingSANITY_API_READ_TOKEN: Dashboard Sanity â Settings â API â TokensSANITY_API_WRITE_TOKEN: Dashboard Sanity â Settings â API â TokensSANITY_PREVIEW_SECRET: GĂ©nĂ©rĂ© alĂ©atoirement (ex:openssl rand -base64 32)CLOUDFLARE_ACCOUNT_ID: Dashboard Cloudflare â Workers & Pages â Account ID
4. Authentification
Section titled â4. Authentificationâ4.1. Cloudflare Wrangler
Section titled â4.1. Cloudflare Wranglerâ# Authentificationwrangler login
# Vérificationwrangler whoami4.2. Sanity CLI
Section titled â4.2. Sanity CLIâ# Authentificationsanity login
# Vérificationsanity manage whoami5. Configuration VS Code
Section titled â5. Configuration VS Codeâ5.1. Extensions recommandĂ©es
Section titled â5.1. Extensions recommandĂ©esâ| Extension | Usage |
|---|---|
| Astro | Support Astro |
| Sanity | Support Sanity |
| Tailwind CSS IntelliSense | Support Tailwind |
| ESLint | Linting |
| Prettier | Formatting |
| GitLens | Git amélioré |
5.2. Configuration .vscode/settings.json
Section titled â5.2. Configuration .vscode/settings.jsonâ{ "editor.formatOnSave": true, "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.codeActionsOnSave": { "source.fixAll.eslint": true }, "files.associations": { "*.astro": "astro" }}6. Lancement du serveur de dĂ©veloppement
Section titled â6. Lancement du serveur de dĂ©veloppementâ6.1. Build local
Section titled â6.1. Build localâ# Build du projetnpm run build
# Preview localnpm run preview6.2. Développement local
Section titled â6.2. DĂ©veloppement localâ# Serveur de dĂ©veloppementnpm run devLe site sera accessible sur http://localhost:4321.
7. Tests
Section titled â7. Testsâ7.1. Lancer les tests
Section titled â7.1. Lancer les testsâ# Tests unitairesnpm run test
# Tests E2Enpm run test:e2e7.2. Linting
Section titled â7.2. Lintingâ# Lintingnpm run lint
# Type checkingnpm run typecheck8. Workflow Git
Section titled â8. Workflow Gitâ8.1. CrĂ©er une branche
Section titled â8.1. CrĂ©er une brancheâ# Se mettre sur developgit checkout develop
# Pull les derniĂšres modificationsgit pull origin develop
# Créer une branche featuregit checkout -b feature/slice-X-tache8.2. Commiter les modifications
Section titled â8.2. Commiter les modificationsâ# Ajouter les fichiersgit add .
# Commitergit commit -m "feat: description de la modification"
# Pushergit push origin feature/slice-X-tache8.3. Créer une Pull Request
Section titled â8.3. CrĂ©er une Pull Requestâ- Aller sur GitHub
- Cliquer sur âNew Pull Requestâ
- Sélectionner la branche
feature/slice-X-tacheversdevelop - Remplir le template de PR
- Soumettre pour review
9. Déploiement local (Wrangler)
Section titled â9. DĂ©ploiement local (Wrangler)â9.1. DĂ©ploiement staging
Section titled â9.1. DĂ©ploiement stagingâ# DĂ©ploiement stagingwrangler pages deploy dist --project-name=votre-projet-staging9.2. Logs en temps rĂ©el
Section titled â9.2. Logs en temps rĂ©elâ# Logs du workerwrangler tail10. Sanity Studio local
Section titled â10. Sanity Studio localâ10.1. Lancer le Studio
Section titled â10.1. Lancer le Studioâ# Lancer le Studionpm run sanity:devLe Studio sera accessible sur http://localhost:3333.
11. Dépannage
Section titled â11. DĂ©pannageâ11.1. ProblĂšmes courants
Section titled â11.1. ProblĂšmes courantsâ| SymptĂŽme | Cause probable | Solution |
|---|---|---|
npm install échoue |
Version Node.js incompatible | Mettre Ă jour Node.js |
wrangler login échoue |
Permissions insuffisantes | Vérifier les permissions Cloudflare |
| Variables dâenvironnement non chargĂ©es | Fichier .env manquant |
Créer le fichier .env |
| Build échoue | Dépendances manquantes | npm install |
11.2. Ressources
Section titled â11.2. Ressourcesâ- Documentation Astro : https://docs.astro.build/
- Documentation Sanity : https://www.sanity.io/docs
- Documentation Cloudflare : https://developers.cloudflare.com/
12. Checklist de validation
Section titled â12. Checklist de validationâAvant de commencer le dĂ©veloppement, vĂ©rifier :
- Node.js 20+ installé
- Git installé
- VS Code installé
- Wrangler CLI installé
- Sanity CLI installé
- Repository cloné
- Dépendances installées
- Variables dâenvironnement configurĂ©es
- Authentification Cloudflare réussie
- Authentification Sanity réussie
- Serveur de développement fonctionne
- Tests passent
- Linting passe
13. Prochaines étapes
Section titled â13. Prochaines Ă©tapesâUne fois le setup local terminĂ© :
- Lire le guide de contribution (
CONTRIBUTING.md) - Lire la méthodologie de développement (
Standard-operating-procedure.md) - Consulter lâordre des slices (
Phase0-Ordre-Slices.md) - Commencer par Slice 1 : SchĂ©ma Sanity âpageâ
14. Support
Section titled â14. SupportâEn cas de problĂšme :
- Canal Slack : #dev
- Email : dev@votre-entreprise.com
- Documentation : Repository GitHub
15. Historique des modifications
Section titled â15. Historique des modificationsâ| Date | Version | Description | Auteur |
|---|---|---|---|
| YYYY-MM-DD | 1.0 | Création initiale | [Nom] |