https://github.com/alextraveylan/household_budget_demo
API de demo pour docstrings
https://github.com/alextraveylan/household_budget_demo
Last synced: 3 months ago
JSON representation
API de demo pour docstrings
- Host: GitHub
- URL: https://github.com/alextraveylan/household_budget_demo
- Owner: AlexTraveylan
- License: mit
- Created: 2024-09-10T20:40:57.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-10T20:59:26.000Z (9 months ago)
- Last Synced: 2025-01-13T10:51:00.125Z (5 months ago)
- Language: Python
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API de Gestion de Budget
Une API robuste pour la gestion de budget personnel, construite avec Django et django-ninja.
## Fonctionnalités
- Gestion des utilisateurs et authentification
- Enregistrement et suivi des transactions
## Prérequis
- Python 3.8+
- Django 3.2+
- django-ninja
## Environnement
Copiez le fichier `.env.exemple` en `.env` et remplissez les variables d'environnement.
## Installation
1. Créez un environnement virtuel et activez-le :
```bash
python -m venv venv
source venv/bin/activate # Sur Windows, utilisez `venv\Scripts\activate`
```
2. Installez les dépendances :
```bash
pip install -r requirements.txt
```
3. Configurez les variables d'environnement dans un fichier `.env` à la racine du projet.
4. Appliquez les migrations :
```bash
python manage.py migrate
```
5. Lancez le serveur de développement :
```bash
python manage.py runserver
```
## Utilisation
Accédez à l'interface API à l'adresse `http://localhost:8000/api/docs` pour explorer et tester les endpoints disponibles.
## Contribution
Les contributions sont les bienvenues ! Veuillez consulter le fichier CONTRIBUTING.md pour les directives.
## Licence
Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.