Thanks to visit codestin.com
Credit goes to github.com

Skip to content

flyBoy667/Krone-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

163 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Krone-backend

Python FastAPI PostgreSQL

Description du projet

Krone-backend est une application backend développée en Python utilisant FastAPI. Ce projet a pour but de fournir une API RESTful pour la gestion des utilisateurs, y compris l'authentification et la gestion des rôles. Il est conçu pour être performant, sécurisé et facilement extensible.

Fonctionnalités clés

  • Authentification des utilisateurs
  • Gestion des rôles
  • Gestion des données des utilisateurs
  • Architecture basée sur des routes pour une meilleure organisation du code

Tech Stack

Technologie Description
Python Langage de programmation principal
FastAPI Framework pour construire des APIs
PostgreSQL Système de gestion de base de données

Instructions d'installation

Prérequis

  • Python 3.7 ou supérieur
  • pip (gestionnaire de paquets Python)
  • PostgreSQL (pour la gestion de la base de données)

Guide d'installation

  1. Clonez le dépôt :

    git clone https://github.com/flyBoy667/Krone-backend.git
    cd Krone-backend
  2. Installez les dépendances :

    pip install -r requirements.txt
  3. Configurez la base de données dans le fichier app/core/config.py. Assurez-vous que les informations de connexion sont correctes.

  4. Si des variables d'environnement sont nécessaires, créez un fichier .env à la racine du projet et ajoutez les variables requises. Un exemple de contenu pourrait être :

    DATABASE_URL=postgresql://user:password@localhost/dbname
    

Utilisation

Pour démarrer le serveur, exécutez le fichier main.py :

python main.py

L'API sera accessible par défaut à l'adresse http://localhost:8000.

Exemples d'utilisation

  • Pour vous authentifier, envoyez une requête POST à /api/auth/login avec les informations d'identification de l'utilisateur.
  • Pour obtenir les informations d'un utilisateur, envoyez une requête GET à /api/users/{id}.

Structure du projet

Voici un aperçu de la structure du projet :

Krone-backend/
├── app/
│   ├── api/                # Contient les routes de l'API
│   │   ├── routes/         # Routes spécifiques comme l'authentification et la gestion des utilisateurs
│   │   ├── __init__.py
│   │   ├── api.py          # Point d'entrée de l'API
│   │   └── deps.py         # Dépendances de l'API
│   ├── core/               # Contient la configuration de l'application, la base de données et la sécurité
│   │   ├── __init__.py
│   │   ├── config.py       # Configuration de l'application
│   │   ├── database.py     # Gestion de la base de données
│   │   └── security.py     # Logique de sécurité
│   ├── models/             # Modèles de données
│   │   └── User.py         # Modèle utilisateur
│   └── schemas/            # Schémas de validation
│       └── User.py         # Schéma utilisateur
├── main.py                 # Point d'entrée principal de l'application
├── requirements.txt        # Liste des dépendances
└── vercel.json             # Configuration pour le déploiement sur Vercel

Contribuer

Les contributions sont les bienvenues ! Pour contribuer, veuillez suivre ces étapes :

  1. Forkez le projet.
  2. Créez votre branche (git checkout -b feature/YourFeature).
  3. Commitez vos modifications (git commit -m 'Add some feature').
  4. Poussez vers la branche (git push origin feature/YourFeature).
  5. Ouvrez une Pull Request.

Nous vous remercions de votre intérêt pour le projet Krone-backend !

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages