FastAPI Template

Template FASTAPI

Keterangan

Template FASTAPI adalah templat proyek yang menyediakan struktur file yang baik dan pengaturan untuk membangun aplikasi FASTAPI. Ini mencakup lingkungan pengembangan yang telah dikonfigurasi sebelumnya, skrip penyebaran siap-produksi, dan opsi konfigurasi SSL. Template ini bertujuan untuk memudahkan pengembang untuk memulai proyek FASTAPI baru dengan fondasi yang kuat dan praktik terbaik dalam pikiran.

Fitur

• Bersihkan struktur file untuk mengatur aplikasi FASTAPI Anda
• Pengaturan Lingkungan Virtual untuk Ketergantungan Terisolasi
• Skrip bash siap-produksi untuk penempatan
• Pengaturan SSL yang dapat dikonfigurasi untuk koneksi yang aman
• Logging pra-konfigurasi dengan log disimpan ke file
• Web UI untuk melihat dan mencari log dengan banyak opsi

Instalasi

1. Klon Repositori:

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

2. Buat lingkungan virtual dan aktifkan:

python3 -m venv virtualenv
source virtualenv/bin/activate

3. Instal dependensi yang diperlukan:

pip3 install -r requirements.txt

Penggunaan

Untuk menjalankan aplikasi secara lokal, menggunakan Uvicorn atau Gunicorn:

Menggunakan Uvicorn: uvicorn api.main:app --reload --port 8086

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

Aplikasi akan mulai berjalan di http: // localhost: 8086.

Penyebaran

Untuk penyebaran produksi, template menyediakan pipa CI Docker dan file konfigurasi docker-compose untuk penempatan yang mudah.

Berkontribusi

Kontribusi dipersilakan! Jika Anda ingin berkontribusi pada template Fastapi, silakan ikuti langkah -langkah ini:

1. Garpu repositori
2. Buat cabang baru untuk fitur atau perbaikan bug Anda
3. Buat perubahan Anda dan lakukan
4. Dorong perubahan Anda ke garpu Anda
5. Kirimkan permintaan tarik ke cabang master dari repositori asli

Pastikan untuk mengikuti gaya kode yang ada dan menambahkan tes untuk fitur baru atau perbaikan bug.

Lisensi

Template FASTAPI dirilis di bawah lisensi MIT. Anda bebas menggunakan, memodifikasi, dan mendistribusikan templat ini untuk tujuan apa pun.