FastAPI Template

Fastapi -Vorlage

Beschreibung

Die Fastapi -Vorlage ist eine Projektvorlage, die eine gute Dateistruktur und ein Setup zum Erstellen von Fastapi -Anwendungen bietet. Es umfasst eine vorkonfigurierte Entwicklungsumgebung, Produktionsbereitstellungsskripte und SSL-Konfigurationsoptionen. Diese Vorlage soll es den Entwicklern erleichtern, neue Fastapi -Projekte mit einer robusten Grundlage und bewährten Verfahren zu starten.

Merkmale

• Reinigen Sie die Dateistruktur für die Organisation Ihrer Fastapi -Anwendung
• Virtuelle Umgebung Aufbau für isolierte Abhängigkeiten
• Produktionsbereitete Bash-Skripte für die Bereitstellung
• Konfigurierbares SSL -Setup für sichere Verbindungen
• Vorkonfigurierte Protokollierung mit in einer Datei gespeicherten Protokollen
• Web -Benutzeroberfläche zum Anzeigen und Durchsuchen von Protokollen mit vielen Optionen

Installation

1. Klonen Sie das Repository:

git clone https://github.com/Neko-Nik/FastAPI-Template.git
cd FastAPI-Template

2. Erstellen Sie eine virtuelle Umgebung und aktivieren Sie sie:

python3 -m venv virtualenv
source virtualenv/bin/activate

3. Installieren Sie die erforderlichen Abhängigkeiten:

pip3 install -r requirements.txt

Verwendung

Um die Anwendung lokal mit Uvicorn oder Gunicorn auszuführen:

Verwenden Sie Uvicorn: uvicorn api.main:app --reload --port 8086

Verwenden von Gunicorn: gunicorn -k uvicorn.workers.UvicornWorker api.main:app

Die Anwendung wird auf http: // localhost: 8086 ausgeführt.

Einsatz

Für die Produktionsbereitstellung enthält die Vorlage Docker CI Pipeline und docker-compose Konfigurationsdateien für eine einfache Bereitstellung.

Beitragen

Beiträge sind willkommen! Wenn Sie zu einer Fastapi -Vorlage beitragen möchten, befolgen Sie die folgenden Schritte:

1. Geben Sie das Repository auf
2. Erstellen Sie eine neue Filiale für Ihre Funktion oder Ihre Fehlerbehebung
3. Nehmen Sie Ihre Änderungen vor und begehen Sie sie
4. Drücken Sie Ihre Änderungen in Ihre Gabel
5. Senden Sie eine Pull -Anfrage an den master -Zweig des ursprünglichen Repositorys

Bitte befolgen Sie den vorhandenen Codestil und fügen Sie Tests für neue Funktionen oder Fehlerbehebungen hinzu.

Lizenz

Die Fastapi -Vorlage wird unter der MIT -Lizenz veröffentlicht. Sie können diese Vorlage für jeden Zweck frei verwenden, ändern und verteilen.