docs: overhaul and expand technical documentation
Revamped the documentation structure and content to enhance usability and organization. Added detailed sections on architecture, pipeline, security, API reference, deployment steps, compliance, and supported modules. Introduced new visuals like cards, accordions, and callouts for improved readability and navigation.
This commit is contained in:
@@ -7,22 +7,39 @@ description: Technologies utilisées dans le projet Memegoat
|
||||
|
||||
### Frontend
|
||||
|
||||
- **Framework** : NextJS
|
||||
- **Gestion d'état** : Zustand
|
||||
- **Style** : Tailwind CSS
|
||||
- **Composants UI** : Shadcn/ui
|
||||
<Cards>
|
||||
<Card title="NextJS" description="Framework React pour le SSR et la performance." />
|
||||
<Card title="Tailwind CSS" description="Design système utilitaire pour le styling." />
|
||||
<Card title="Zustand" description="Gestion d'état légère et performante." />
|
||||
<Card title="Shadcn/ui" description="Composants UI accessibles et personnalisables." />
|
||||
</Cards>
|
||||
|
||||
### Backend
|
||||
|
||||
- **Framework** : NestJS
|
||||
- **Langage** : TypeScript
|
||||
- **Base de données** : PostgresQL
|
||||
- **ORM** : DrizzleORM
|
||||
<Cards>
|
||||
<Card title="NestJS" description="Framework Node.js modulaire et robuste." />
|
||||
<Card title="PostgreSQL" description="Base de données relationnelle puissante." />
|
||||
<Card title="Redis" description="Store clé-valeur pour le cache haute performance." />
|
||||
<Card title="Drizzle ORM" description="ORM TypeScript-first avec support des migrations." />
|
||||
<Card title="Sharp & FFmpeg" description="Traitement haute performance des images et vidéos." />
|
||||
</Cards>
|
||||
|
||||
### Sécurité & Monitoring
|
||||
|
||||
<Cards>
|
||||
<Card title="ClamAV" description="Protection antivirus en temps réel." />
|
||||
<Card title="Sentry" description="Reporting d'erreurs et profiling de performance." />
|
||||
<Card title="Argon2id" description="Hachage de mots de passe de grade militaire." />
|
||||
<Card title="PGP (pgcrypto)" description="Chiffrement natif des données sensibles." />
|
||||
<Card title="otplib" description="Implémentation TOTP pour la 2FA." />
|
||||
<Card title="iron-session" description="Gestion sécurisée des sessions via cookies chiffrés." />
|
||||
</Cards>
|
||||
|
||||
### Infrastructure & DevOps
|
||||
|
||||
- **Conteneurisation** : Docker / Docker Compose
|
||||
- **Reverse Proxy & TLS** : Caddy
|
||||
- **Stockage d'objets** : MinIO (compatible S3)
|
||||
- **CI/CD** : Gitea Actions
|
||||
- **Hébergement** : Hetzner Dedicated Server
|
||||
<Cards>
|
||||
<Card title="Docker" description="Conteneurisation et orchestration (Compose)." />
|
||||
<Card title="Caddy" description="Reverse proxy moderne avec TLS automatique." />
|
||||
<Card title="MinIO" description="Stockage d'objets auto-hébergé compatible S3." />
|
||||
<Card title="Hetzner" description="Hébergement sur serveurs dédiés en Europe." />
|
||||
</Cards>
|
||||
|
||||
Reference in New Issue
Block a user