Bienvenue sur Datte-MVP, la première pierre d'une révolution (pas autant quand même, mais oui sinon) dans l'univers des API modulables !
Ici, vous découvrez une plateforme back-end générique et extensible, pensée pour s'adapter à une multitude de projets : gestion de contenu, e-commerce, prise de rendez-vous, et bien plus encore. Son objectif est d'arriver à être modulable pour tout type d'API.
Attention : Il s'agit d'un MVP (Minimum Viable Product), une base qui pose les fondations de Datte, mais qui reste en phase d'expérimentation pour l'instant. 🚀

• Modularité Totale : Chaque fonctionnalité est (DEVRAIT ETRE) un module indépendant, vous permettant d'ajouter, modifier ou supprimer des composants sans perturber l'ensemble.
• Architecture Épurée : Conçu selon des design patterns éprouvés et en respectant rigoureusement les principes SOLID, pour un code à la fois propre, maintenable et évolutif.
• Technologies Modernes : Fonctionne avec MySQL et TypeORM, garantissant une gestion efficace des données et une intégration fluide dans vos projets.
• Vision d'Avenir : Ce MVP n'est que le début. Il pose la base sur laquelle Datte-C1 (Core-1) viendra ajouter des fonctionnalités innovantes.

L'organisation du code a été pensée pour être intuitive et évolutive :

src/
├── modules/          # Modules fonctionnels (utilisateurs, produits, etc.)
├── config/           # Configurations environnementales et de connexion (BDD, etc.)
└── repositories/     # Accès aux données via MySQL et TypeORM
...

Chaque dossier a pour but de faciliter l'ajout de nouvelles fonctionnalités tout en maintenant une séparation claire des responsabilités.

• Inscription & Connexion Sécurisées : Authentification par tokens JWT, gestion des sessions et sécurité avancée.
• Profils Personnalisables : Paramétrez les préférences, notifications et langues pour une expérience utilisateur sur-mesure.
• Rôles & Permissions Intégrés : Un module dédié assure une gestion fine et hiérarchisée des accès.

• Base de Données : Utilisation native de MySQL avec TypeORM pour une gestion relationnelle robuste.
• Design Patterns Appliqués : Factory, Strategy, Observer, et bien d'autres, pour un code organisé et prêt à évoluer.
• Respect des Principes SOLID : Un engagement total pour un code modulaire, facile à maintenir et à développer.

L'aventure ne fait que commencer ! La prochaine version, Datte-Core 1, viendra enrichir la plateforme avec des fonctionnalités inédites :

• Module IA Innovant : Des endpoints dédiés permettront bientôt d'interagir avec une intelligence artificielle, ouvrant la voie à des conversations intelligentes et automatisées 🤖.
• Support Multi-BDD : Outre MySQL, vous aurez le choix d'utiliser Redis dès l'installation, pour une flexibilité maximale selon vos besoins.

• Node.js (version recommandée 14+)
• npm ou yarn
• MySQL installé et configuré

1. Clonez le dépôt :

   git clone https://github.com/byborh/datte
   cd datte

2. Installez les dépendances :

   npm install

Voici la version corrigée pour prendre en compte le fait que make prod et make dev gèrent MySQL automatiquement :

Vous avez deux options pour lancer l'application :

• Via npm (nécessite une base de données MySQL déjà configurée) :

  npm run datte
  
  # Ou
  
  npm run dev

  ⚠️ Assurez-vous que votre base de données est déjà en place avant de démarrer l’application.

• Via Makefile (démarre MySQL automatiquement avant l'application) :

  • En mode développement :

    make dev

    MySQL sera démarré automatiquement si nécessaire.

  • En mode production :

    make prod

    Cette commande s'assure que MySQL est bien lancé et configure l’environnement avant de démarrer l’application en production.

4. Accédez à l'API :
   Rendez-vous sur http://localhost:3000/api/v1.0.0 pour explorer les endpoints.

Pour vous donner une idée, voici quelques endpoints clés disponibles dès maintenant :

• Utilisateurs :

  • Inscription : /users
  • Connexion : /users/login

• Rôles & Permissions :

  • Gestion des rôles : /roles
  • Attribution des rôles aux utilisateurs via /users/{userId}/roles/{roleId}

Pour une liste complète des endpoints, veuillez consulter la documentation intégrée dans le code.

Pour garantir une sécurité optimale, tous nos endpoints sont protégés par des tokens JWT signés avec l'algorithme ES256. Voici ce que cela implique :

• 🗝️ Clé Privée : Utilisée pour signer et générer les tokens.
• 🔓 Clé Publique : Fournie dans le fichier ec_public.pem, elle permet de valider les signatures.

Important : Assurez-vous de générer ces clés à l'aide d'outils cryptographiques fiables pour garantir l'intégrité et la sécurité de l'authentification.

Pour génrérer ces clés, utiliser ces commandes :

openssl ec -in ec_private.pem -text -noout

openssl ec -in ec_private.pem -pubout -outform PEM  

• Kazakh - Développeur Principal & Architecte & Gestion de Projet
• Emmario - Le DevSecOps et le mentor

Ce projet est sous licence GNU GPL v3 - voir le fichier LICENSE pour plus de détails.

Merci à tous ceux qui ont/vont contribué(r) au projet Datte. Notamment un grand merci à ma famille qui me supporte au quotidien et à Emmario, sans lui, la prod' m'aurait pris au moins 2 semaines (et encore).

Vos retours nous aident à faire évoluer le projet. 💖

Rejoignez l'aventure Datte et participez à la révolution des API modulables – ensemble, construisons le futur (ou pas... qui sait) !