Ajout du fichier README.md avec des instructions d'installation, des technologies utilisées et des informations sur la structure du projet

This commit is contained in:
Kevin 2025-02-17 18:56:01 +01:00
parent 8e00d47607
commit e9275f2ece

85
README.md Normal file
View File

@ -0,0 +1,85 @@
# Neah-Enkun
Une application web moderne construite avec Next.js, TailwindCSS et TypeScript.
## 🚀 Installation
```bash
# Cloner le dépôt
git clone <url-du-repo>
# Installer les dépendances
npm install
```
## 🛠️ 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
```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
```