Neah-Enkun/README.md

2.4 KiB

Neah-Enkun

Une application web moderne construite avec Next.js, TailwindCSS et TypeScript.

🚀 Installation

Utilisation de Docker

# 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

# 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

📁 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 :

⚙️ Scripts disponibles

Avec Docker

# Construire et démarrer les conteneurs Docker
docker-compose up --build

# Arrêter les conteneurs Docker
docker-compose down

Sans Docker

# 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. 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 :

npm test

📦 Production

Pour déployer en production :

npm run build
npm start