docs: update README to reflect project features, installation instructions, and project structure in French
This commit is contained in:
91
README.md
91
README.md
@@ -1,36 +1,81 @@
|
|||||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
# 🚀 Workshop Manager
|
||||||
|
|
||||||
## Getting Started
|
Plateforme d'ateliers managériaux interactifs et collaboratifs.
|
||||||
|
|
||||||
First, run the development server:
|
## ✨ Fonctionnalités
|
||||||
|
|
||||||
|
### 📊 Analyse SWOT
|
||||||
|
Cartographiez les forces, faiblesses, opportunités et menaces de vos collaborateurs.
|
||||||
|
- Matrice interactive avec drag & drop
|
||||||
|
- Actions croisées et plan de développement
|
||||||
|
- Collaboration en temps réel
|
||||||
|
|
||||||
|
### 🎯 Moving Motivators
|
||||||
|
Explorez les 10 motivations intrinsèques (Management 3.0).
|
||||||
|
- Classement par importance
|
||||||
|
- Évaluation de l'influence positive/négative
|
||||||
|
- Récapitulatif personnalisé
|
||||||
|
|
||||||
|
### 🤝 Collaboration
|
||||||
|
- Partage de sessions (Éditeur / Lecteur)
|
||||||
|
- Synchronisation temps réel (SSE)
|
||||||
|
- Historique sauvegardé
|
||||||
|
|
||||||
|
## 🛠️ Stack technique
|
||||||
|
|
||||||
|
- **Framework** : Next.js 16 (App Router)
|
||||||
|
- **Base de données** : SQLite + Prisma ORM
|
||||||
|
- **Auth** : NextAuth.js
|
||||||
|
- **UI** : Tailwind CSS + CSS Variables theming
|
||||||
|
- **Drag & Drop** : @dnd-kit
|
||||||
|
|
||||||
|
## 🚀 Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
# Cloner le repo
|
||||||
# or
|
git clone <repo-url>
|
||||||
yarn dev
|
cd swot-manager
|
||||||
# or
|
|
||||||
|
# Installer les dépendances
|
||||||
|
pnpm install
|
||||||
|
|
||||||
|
# Configurer l'environnement
|
||||||
|
cp .env.example .env
|
||||||
|
# Éditer .env avec vos valeurs
|
||||||
|
|
||||||
|
# Initialiser la base de données
|
||||||
|
pnpm prisma migrate dev
|
||||||
|
|
||||||
|
# Lancer le serveur de développement
|
||||||
pnpm dev
|
pnpm dev
|
||||||
# or
|
|
||||||
bun dev
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
Ouvrir [http://localhost:3000](http://localhost:3000)
|
||||||
|
|
||||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
## 📁 Structure du projet
|
||||||
|
|
||||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
```
|
||||||
|
src/
|
||||||
|
├── app/ # Pages Next.js (App Router)
|
||||||
|
│ ├── sessions/ # Ateliers SWOT
|
||||||
|
│ ├── motivators/ # Ateliers Moving Motivators
|
||||||
|
│ └── api/ # API Routes
|
||||||
|
├── components/ # Composants React
|
||||||
|
│ ├── swot/ # Composants SWOT
|
||||||
|
│ ├── moving-motivators/ # Composants Moving Motivators
|
||||||
|
│ ├── collaboration/ # Partage & temps réel
|
||||||
|
│ └── ui/ # Composants UI génériques
|
||||||
|
├── services/ # Logique métier (accès BDD)
|
||||||
|
├── actions/ # Server Actions
|
||||||
|
├── hooks/ # React hooks
|
||||||
|
└── lib/ # Types & utilitaires
|
||||||
|
```
|
||||||
|
|
||||||
## Learn More
|
## 🎨 Theming
|
||||||
|
|
||||||
To learn more about Next.js, take a look at the following resources:
|
Le projet utilise des CSS Variables pour le theming (light/dark).
|
||||||
|
Voir `src/app/globals.css` pour les variables disponibles.
|
||||||
|
|
||||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
## 📝 License
|
||||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
|
||||||
|
|
||||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
MIT
|
||||||
|
|
||||||
## Deploy on Vercel
|
|
||||||
|
|
||||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
|
||||||
|
|
||||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user