122 lines
2.4 KiB
Markdown
122 lines
2.4 KiB
Markdown
# Neah-Enkun
|
|
|
|
Une application web moderne construite avec Next.js, TailwindCSS et TypeScript.
|
|
|
|
## 🚀 Installation
|
|
|
|
### Utilisation de Docker
|
|
|
|
```bash
|
|
# Cloner le dépôt
|
|
git clone <url-du-repo>
|
|
|
|
# Naviguer dans le répertoire du projet
|
|
cd Neah-Enkun
|
|
|
|
# Construire et démarrer les conteneurs Docker
|
|
docker-compose up -d --build
|
|
```
|
|
|
|
### Installation manuelle
|
|
|
|
```bash
|
|
# Cloner le dépôt
|
|
git clone <url-du-repo>
|
|
|
|
# Naviguer dans le répertoire du projet
|
|
cd Neah-Enkun/front
|
|
|
|
# Installer les dépendances
|
|
npm install
|
|
|
|
# Build
|
|
npm run build
|
|
|
|
# Lancer l'application
|
|
npm start
|
|
```
|
|
|
|
## 🛠️ Technologies utilisées
|
|
|
|
- [Next.js](https://nextjs.org/) - Framework React
|
|
- [TailwindCSS](https://tailwindcss.com/) - Framework CSS
|
|
- [TypeScript](https://www.typescriptlang.org/) - Typage statique
|
|
- [Shadcn UI](https://ui.shadcn.com/) - Composants UI
|
|
|
|
## 📁 Structure du projet
|
|
|
|
```
|
|
├── app/ # Pages et routes Next.js
|
|
├── components/ # Composants React réutilisables
|
|
├── hooks/ # Hooks React personnalisés
|
|
├── lib/ # Utilitaires et fonctions
|
|
├── public/ # Fichiers statiques
|
|
└── styles/ # Styles globaux
|
|
```
|
|
|
|
## 🔧 Configuration
|
|
|
|
Le projet utilise plusieurs fichiers de configuration :
|
|
|
|
- [`next.config.mjs`](next.config.mjs) - Configuration Next.js
|
|
- [`tailwind.config.ts`](tailwind.config.ts) - Configuration TailwindCSS
|
|
- [`tsconfig.json`](tsconfig.json) - Configuration TypeScript
|
|
- [`components.json`](components.json) - Configuration des composants UI
|
|
|
|
## ⚙️ Scripts disponibles
|
|
|
|
### Avec Docker
|
|
|
|
```bash
|
|
# Construire et démarrer les conteneurs Docker
|
|
docker-compose up --build
|
|
|
|
# Arrêter les conteneurs Docker
|
|
docker-compose down
|
|
```
|
|
|
|
### Sans Docker
|
|
|
|
```bash
|
|
# Démarrer le serveur de développement
|
|
npm run dev
|
|
|
|
# Construire l'application
|
|
npm run build
|
|
|
|
# Démarrer l'application en production
|
|
npm start
|
|
```
|
|
|
|
## 🎨 Personnalisation
|
|
|
|
Le thème peut être personnalisé via TailwindCSS dans [`tailwind.config.ts`](tailwind.config.ts). Les variables CSS sont utilisées pour les couleurs principales :
|
|
|
|
- `--background`
|
|
- `--foreground`
|
|
- `--card`
|
|
- `--popover`
|
|
- `--primary`
|
|
- `--secondary`
|
|
|
|
## 📝 Note
|
|
|
|
N'oubliez pas de configurer votre `.env` si nécessaire pour les variables d'environnement.
|
|
|
|
## 🧪 Tests
|
|
|
|
Les tests peuvent être exécutés avec :
|
|
|
|
```bash
|
|
npm test
|
|
```
|
|
|
|
## 📦 Production
|
|
|
|
Pour déployer en production :
|
|
|
|
```bash
|
|
npm run build
|
|
npm start
|
|
```
|