135 lines
2.6 KiB
Markdown
135 lines
2.6 KiB
Markdown
# P'titsPas
|
|
|
|
Plateforme de gestion de la garde d'enfants pour les collectivités locales.
|
|
|
|
## Workflow de développement
|
|
|
|
Le projet suit un workflow simple :
|
|
- `develop` : branche principale de développement
|
|
- `main` : branche des versions stables
|
|
|
|
### Processus de release
|
|
1. Développement sur la branche `develop`
|
|
2. Tests et validation
|
|
3. Merge vers `main` avec tag de version
|
|
4. Mise à jour du CHANGELOG.md
|
|
|
|
## Charte graphique
|
|
|
|
- **Nom** : P'titsPas
|
|
- **Couleurs principales** :
|
|
- Bleu : #2B6CB0 (inspiré du logo)
|
|
- Blanc : #FFFFFF
|
|
- Gris clair : #F7FAFC
|
|
- **Typographie** :
|
|
- Titres : Google Fonts "Comfortaa"
|
|
- Corps : Google Fonts "Roboto"
|
|
|
|
## Prérequis
|
|
|
|
### Backend
|
|
- Node.js (version 18 ou supérieure)
|
|
- PostgreSQL (version 15 ou supérieure)
|
|
- npm (version 9 ou supérieure)
|
|
|
|
### Frontend
|
|
- Flutter SDK (version 3.0 ou supérieure)
|
|
- Dart SDK (version 3.0 ou supérieure)
|
|
- Chrome (pour le développement web)
|
|
|
|
## Installation
|
|
|
|
1. Cloner le dépôt :
|
|
```bash
|
|
git clone [URL_DU_REPO]
|
|
cd ptitspas
|
|
git checkout develop
|
|
```
|
|
|
|
2. Installer le backend :
|
|
```bash
|
|
cd backend
|
|
npm install
|
|
```
|
|
|
|
3. Installer le frontend :
|
|
```bash
|
|
cd ../frontend
|
|
flutter pub get
|
|
```
|
|
|
|
4. Configurer la base de données :
|
|
```bash
|
|
# Créer la base de données
|
|
createdb ptitspas
|
|
|
|
# Configurer les variables d'environnement
|
|
cp .env.example .env
|
|
# Éditer le fichier .env avec vos paramètres de base de données
|
|
```
|
|
|
|
## Démarrage
|
|
|
|
1. Démarrer le backend :
|
|
```bash
|
|
cd backend
|
|
npm run dev
|
|
```
|
|
|
|
2. Démarrer le frontend :
|
|
```bash
|
|
cd frontend
|
|
flutter run -d chrome
|
|
```
|
|
|
|
## Accès aux services
|
|
|
|
- Frontend : http://localhost:8080
|
|
- Backend API : http://localhost:3000
|
|
- Base de données PostgreSQL : localhost:5432
|
|
|
|
## Structure du projet
|
|
|
|
```
|
|
ptitspas/
|
|
├── backend/ # API Node.js/Express
|
|
│ ├── src/ # Code source
|
|
│ ├── prisma/ # Configuration de la base de données
|
|
│ └── tests/ # Tests
|
|
├── frontend/ # Application Flutter
|
|
│ ├── lib/ # Code source
|
|
│ ├── assets/ # Images, polices, etc.
|
|
│ └── test/ # Tests
|
|
├── CHANGELOG.md # Historique des versions
|
|
└── README.md # Documentation
|
|
```
|
|
|
|
## Développement
|
|
|
|
### Backend
|
|
- Langage : TypeScript
|
|
- Framework : Express
|
|
- Base de données : PostgreSQL avec Prisma
|
|
- API : REST avec OpenAPI 3
|
|
|
|
### Frontend
|
|
- Framework : Flutter
|
|
- État : Provider
|
|
- Navigation : Go Router
|
|
- UI : Material Design avec thème personnalisé
|
|
|
|
## Tests
|
|
|
|
```bash
|
|
# Backend
|
|
cd backend
|
|
npm test
|
|
|
|
# Frontend
|
|
cd frontend
|
|
flutter test
|
|
```
|
|
|
|
## Licence
|
|
|
|
Propriétaire - Tous droits réservés |