From e9275f2ecee91959b4f5024e7a9d1418c3f87ed6 Mon Sep 17 00:00:00 2001 From: Kevin Date: Mon, 17 Feb 2025 18:56:01 +0100 Subject: [PATCH] =?UTF-8?q?Ajout=20du=20fichier=20README.md=20avec=20des?= =?UTF-8?q?=20instructions=20d'installation,=20des=20technologies=20utilis?= =?UTF-8?q?=C3=A9es=20et=20des=20informations=20sur=20la=20structure=20du?= =?UTF-8?q?=20projet?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1109924 --- /dev/null +++ b/README.md @@ -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 + +# 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 +```