Spaces:
Sleeping
Sleeping
docs: add README with HF Space metadata
Browse files
README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Akompta Backend
|
| 3 |
+
emoji: 💰
|
| 4 |
+
colorFrom: green
|
| 5 |
+
colorTo: blue
|
| 6 |
+
sdk: docker
|
| 7 |
+
pinned: false
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
# Akompta AI - Backend API
|
| 11 |
+
|
| 12 |
+
Ceci est le backend de l'application **Akompta AI**, une plateforme de gestion financière et comptable.
|
| 13 |
+
|
| 14 |
+
## 🚀 Déploiement sur Hugging Face Spaces
|
| 15 |
+
|
| 16 |
+
Ce backend est configuré pour s'exécuter dans un conteneur Docker sur Hugging Face Spaces.
|
| 17 |
+
|
| 18 |
+
### Configuration requise (Variables d'environnement)
|
| 19 |
+
|
| 20 |
+
Pour que l'API fonctionne correctement, assurez-vous de configurer les variables suivantes dans les "Settings" de votre Space :
|
| 21 |
+
|
| 22 |
+
- `DEBUG`: `False`
|
| 23 |
+
- `SECRET_KEY`: Votre clé secrète Django
|
| 24 |
+
- `ALLOWED_HOSTS`: `*`
|
| 25 |
+
- `CORS_ALLOWED_ORIGINS`: `https://akompta-ai-flame.vercel.app` (ou l'URL de votre frontend)
|
| 26 |
+
- `GEMINI_API_KEY`: Votre clé API Google Gemini
|
| 27 |
+
|
| 28 |
+
## 🛠️ Technologies utilisées
|
| 29 |
+
|
| 30 |
+
- **Framework**: Django 5.2 + Django REST Framework
|
| 31 |
+
- **Authentification**: JWT (Simple JWT)
|
| 32 |
+
- **Base de données**: SQLite
|
| 33 |
+
- **Serveur de production**: Gunicorn
|
| 34 |
+
- **Statique**: WhiteNoise
|
| 35 |
+
|
| 36 |
+
## 📂 Structure du Backend
|
| 37 |
+
|
| 38 |
+
- `Akompta/`: Configuration du projet Django
|
| 39 |
+
- `api/`: Application principale contenant les modèles, vues et logic métier
|
| 40 |
+
- `static/`: Fichiers statiques collectés
|
| 41 |
+
- `Dockerfile`: Configuration pour le déploiement
|
| 42 |
+
- `start.sh`: Script de démarrage pour l'application
|
| 43 |
+
|
| 44 |
+
## 🔗 Liens Utiles
|
| 45 |
+
|
| 46 |
+
- **Documentation API**: [API_REFERENCE.md](../API_REFERENCE.md)
|
| 47 |
+
- **Frontend Vercel**: [https://akompta-ai-flame.vercel.app](https://akompta-ai-flame.vercel.app)
|
| 48 |
+
- **Organisation**: CosmoLAB Hub
|
| 49 |
+
|
| 50 |
+
---
|
| 51 |
+
Développé par **Marino ATOHOUN** pour **CosmoLAB Hub**.
|