first commit
This commit is contained in:
134
README.md
Normal file
134
README.md
Normal file
@ -0,0 +1,134 @@
|
||||
# Compagnon du lagon - Pension Marama
|
||||
|
||||
Application web PWA (Progressive Web App) destinée aux clients d'une pension de famille en Polynésie. Cette application remplace le livret d'accueil papier et offre une expérience numérique optimisée pour les connexions internet faibles.
|
||||
|
||||
## Technologies
|
||||
|
||||
- **Framework**: Next.js 14 (App Router)
|
||||
- **Langage**: TypeScript
|
||||
- **Styling**: Tailwind CSS
|
||||
- **Icons**: Lucide-React
|
||||
- **Components**: Shadcn/UI
|
||||
|
||||
## Fonctionnalités
|
||||
|
||||
### Onglet Accueil
|
||||
- Header personnalisé avec numéro de bungalow
|
||||
- Card WiFi avec copie du mot de passe
|
||||
- Widget météo (placeholder)
|
||||
- Section "Le mot du gérant"
|
||||
|
||||
### Onglet Explorer
|
||||
- Liste de catégories (Plages, Restaurants/Roulottes, Epiceries, Activités)
|
||||
- Liste de lieux recommandés par catégorie
|
||||
- Intégration Google Maps pour chaque lieu
|
||||
|
||||
### Onglet Infos Pratiques
|
||||
- FAQ en accordéon (Check-out, Petit-déjeuner, Climatisation, Numéros d'urgence)
|
||||
- Lexique tahitien (5 mots essentiels)
|
||||
|
||||
## Installation
|
||||
|
||||
### Développement local
|
||||
|
||||
```bash
|
||||
# Installer les dépendances
|
||||
npm install
|
||||
|
||||
# Copier le fichier d'environnement
|
||||
cp env.example .env.local
|
||||
|
||||
# Modifier les variables dans .env.local selon vos besoins
|
||||
|
||||
# Lancer le serveur de développement
|
||||
npm run dev
|
||||
```
|
||||
|
||||
L'application sera accessible sur [http://localhost:3000](http://localhost:3000)
|
||||
|
||||
### Docker
|
||||
|
||||
#### Build et run
|
||||
|
||||
```bash
|
||||
# Build de l'image
|
||||
docker-compose build
|
||||
|
||||
# Lancer le conteneur
|
||||
docker-compose up -d
|
||||
|
||||
# Voir les logs
|
||||
docker-compose logs -f
|
||||
|
||||
# Arrêter le conteneur
|
||||
docker-compose down
|
||||
```
|
||||
|
||||
#### Variables d'environnement Docker
|
||||
|
||||
Créez un fichier `.env` à la racine du projet avec vos variables :
|
||||
|
||||
```env
|
||||
NEXT_PUBLIC_BUNGALOW_NUMBER=1
|
||||
NEXT_PUBLIC_WIFI_NAME=Lagon-WiFi
|
||||
NEXT_PUBLIC_WIFI_PASSWORD=motdepasse123
|
||||
NEXT_PUBLIC_GERANT_MESSAGE=Bienvenue dans notre pension de famille !
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
### Variables d'environnement
|
||||
|
||||
- `NEXT_PUBLIC_BUNGALOW_NUMBER`: Numéro du bungalow (dynamique selon le client)
|
||||
- `NEXT_PUBLIC_WIFI_NAME`: Nom du réseau WiFi
|
||||
- `NEXT_PUBLIC_WIFI_PASSWORD`: Mot de passe WiFi
|
||||
- `NEXT_PUBLIC_GERANT_MESSAGE`: Message personnalisé du gérant
|
||||
|
||||
## Structure du projet
|
||||
|
||||
```
|
||||
├── app/
|
||||
│ ├── accueil/ # Page d'accueil
|
||||
│ ├── explorer/ # Page explorer
|
||||
│ ├── infos/ # Page infos pratiques
|
||||
│ ├── api/ # Routes API
|
||||
│ └── layout.tsx # Layout principal
|
||||
├── components/
|
||||
│ ├── accueil/ # Composants page accueil
|
||||
│ ├── explorer/ # Composants page explorer
|
||||
│ ├── infos/ # Composants page infos
|
||||
│ ├── layout/ # Composants layout
|
||||
│ └── ui/ # Composants Shadcn/UI
|
||||
├── lib/ # Utilitaires et configuration
|
||||
└── public/ # Assets statiques et PWA
|
||||
```
|
||||
|
||||
## PWA
|
||||
|
||||
L'application est configurée comme PWA avec :
|
||||
- Manifest.json pour l'installation
|
||||
- Service Worker pour le cache offline
|
||||
- Optimisations pour connexions faibles
|
||||
|
||||
## Design System
|
||||
|
||||
- **Couleur primaire**: #0E7490 (Bleu lagon)
|
||||
- **Couleur secondaire**: #ECFCCB (Vert citron pâle)
|
||||
- **Background**: #FAFAFA (Blanc cassé)
|
||||
- **Typographie**: Inter, minimum 16px
|
||||
- **Bordures**: Très arrondies (rounded-xl, rounded-2xl)
|
||||
|
||||
## Production
|
||||
|
||||
```bash
|
||||
# Build de production
|
||||
npm run build
|
||||
|
||||
# Lancer en production
|
||||
npm start
|
||||
```
|
||||
|
||||
## Licence
|
||||
|
||||
Propriétaire - Tous droits réservés
|
||||
|
||||
Reference in New Issue
Block a user