README.md * markdown

🇫🇷 ExAPI

Avertissement

• ExAPI est actuellement en phase initiale de développement.
• Cette version est fournie à des fins de démonstration et d’expérimentation.

ExAPI est une API moderne, légère et rapide, conçue pour servir de base à des projets backend modulaires.

Elle s’appuie sur Bun et Fastify, offrant un environnement performant, simple à déployer et facile à étendre.

---

🚀 Utilisation

cp .env.example .env  
# Crée un fichier .env et remplis les variables nécessaires

bun i
# Installe les dépendances

bun dev
# Lance le serveur en mode développement (rechargement automatique)

bun run build
# Vérifie la compilation TypeScript

---

🐳 Docker

Avant d’exécuter l’image Docker, crée un fichier .env contenant les mêmes variables que dans .env.example.

docker build -t exapi

docker run -p 5000:5000 --env-file=.env -it --network=host exapi
# --network=host recommandé en local

---

📁 Structure du projet (indicative)

ExAPI/
├── .gitkeeps
├── .github/ ── .gitkeeps
├── docs/ ── .gitkeeps
├── src/
│   ├── .gitkeeps
│   ├── server.ts
│   ├── routes/ ── .gitkeeps
│   ├── plugins/ ── .gitkeeps
│   └── utils/ ── .gitkeeps
├── .env.example
├── .env.production.example
├── .env.development.example
├── dockerfile
├── docker-compose.yml
├── bunfig.toml
├── package.json
├── tsconfig.json
├── ROADMAP.md
├── CHANGELOG.md
├── LICENSE
└── README.md

---

🎯 Objectifs du projet

• Fournir une API simple, rapide et extensible
• Servir de base pour des projets backend modulaires
• Proposer une architecture claire et maintenable
• Faciliter le déploiement (Docker, CI/CD, hébergement gratuit ou low‑cost)

---

📌 État du développement

• Version actuelle : v1.0.0 (initiale)
• Documentation : en cours
• Modules : en cours
• Tests : à venir

---

🤝 Contribution

Les contributions sont les bienvenues.

Merci de respecter :

• la structure du projet
• les conventions de nommage
• la qualité du code
• les bonnes pratiques Fastify/Bun

---

📄 Licence

• Ce projet est distribué sous licence MIT

---