full stack fastapi template

Templat FastAPI Tumpukan Penuh

Tumpukan dan Fitur Teknologi

• ⚡ FastAPI untuk API backend Python.
  • ? SQLModel untuk interaksi database Python SQL (ORM).
  • ? Pydantic, digunakan oleh FastAPI, untuk validasi data dan manajemen pengaturan.
  • ? PostgreSQL sebagai database SQL.
• Bereaksi untuk frontend.
  • ? Menggunakan TypeScript, hooks, Vite, dan bagian lain dari tumpukan frontend modern.
  • ? Chakra UI untuk komponen frontend.
  • ? Klien frontend yang dibuat secara otomatis.
  • ? Penulis naskah drama untuk pengujian End-to-End.
  • ? Dukungan mode gelap.
• ? Docker Compose untuk pengembangan dan produksi.
• Hashing kata sandi aman secara default.
• ? Otentikasi JWT (JSON Web Token).
• ? Pemulihan kata sandi berbasis email.
• ✅ Tes dengan Pytest.
• ? Traefik sebagai proxy terbalik/penyeimbang beban.
• ? Petunjuk penerapan menggunakan Docker Compose, termasuk cara menyiapkan proksi Traefik frontend untuk menangani sertifikat HTTPS otomatis.
• ? CI (integrasi berkelanjutan) dan CD (penerapan berkelanjutan) berdasarkan Tindakan GitHub.

Masuk Dasbor

Dasbor - Admin

Dasbor - Buat Pengguna

Dasbor - Item

Dasbor - Pengaturan Pengguna

Dasbor - Mode Gelap

Dokumentasi API Interaktif

Cara Menggunakannya

Anda cukup melakukan fork atau mengkloning repositori ini dan menggunakannya sebagaimana adanya.

Itu berhasil.

Cara Menggunakan Repositori Pribadi

Jika Anda ingin memiliki repositori pribadi, GitHub tidak akan mengizinkan Anda melakukan fork begitu saja karena tidak mengizinkan perubahan visibilitas fork.

Namun Anda dapat melakukan hal berikut:

• Buat repo GitHub baru, misalnya my-full-stack .
• Kloning repositori ini secara manual, atur namanya dengan nama proyek yang ingin Anda gunakan, misalnya my-full-stack :

git clone [email protected]:fastapi/full-stack-fastapi-template.git my-full-stack

• Masuk ke direktori baru:

 cd my-full-stack

• Tetapkan asal baru ke repositori baru Anda, salin dari antarmuka GitHub, misalnya:

git remote set-url origin [email protected]:octocat/my-full-stack.git

• Tambahkan repo ini sebagai "remote" lain untuk memungkinkan Anda mendapatkan pembaruan nanti:

git remote add upstream [email protected]:fastapi/full-stack-fastapi-template.git

• Dorong kode ke repositori baru Anda:

git push -u origin master

Update Dari Template Asli

Setelah mengkloning repositori, dan setelah melakukan perubahan, Anda mungkin ingin mendapatkan perubahan terbaru dari template asli ini.

• Pastikan Anda menambahkan repositori asli sebagai remote, Anda dapat memeriksanya dengan:

git remote -v

origin    [email protected]:octocat/my-full-stack.git (fetch)
origin    [email protected]:octocat/my-full-stack.git (push)
upstream    [email protected]:fastapi/full-stack-fastapi-template.git (fetch)
upstream    [email protected]:fastapi/full-stack-fastapi-template.git (push)

• Tarik perubahan terbaru tanpa menggabungkan:

git pull --no-commit upstream master

Ini akan mengunduh perubahan terbaru dari templat ini tanpa melakukan perubahan tersebut, sehingga Anda dapat memeriksa semuanya sudah benar sebelum melakukan.

• Jika ada konflik, selesaikan di editor Anda.

• Setelah Anda selesai, komit perubahannya:

git merge --continue

Konfigurasikan

Anda kemudian dapat memperbarui konfigurasi di file .env untuk menyesuaikan konfigurasi Anda.

Sebelum menerapkannya, pastikan Anda mengubah setidaknya nilai untuk:

• SECRET_KEY
• FIRST_SUPERUSER_PASSWORD
• POSTGRES_PASSWORD

Anda dapat (dan harus) meneruskannya sebagai variabel lingkungan dari rahasia.

Baca dokumen deployment.md untuk detail selengkapnya.

Hasilkan Kunci Rahasia

Beberapa variabel lingkungan dalam file .env memiliki nilai default changethis .

Anda harus mengubahnya dengan kunci rahasia, untuk menghasilkan kunci rahasia Anda dapat menjalankan perintah berikut:

python -c " import secrets; print(secrets.token_urlsafe(32)) "

Salin kontennya dan gunakan itu sebagai kata sandi/kunci rahasia. Dan jalankan lagi untuk menghasilkan kunci aman lainnya.

Cara Menggunakannya - Alternatif Dengan Mesin Fotokopi

Repositori ini juga mendukung pembuatan proyek baru menggunakan Copier.

Ini akan menyalin semua file, menanyakan pertanyaan konfigurasi, dan memperbarui file .env dengan jawaban Anda.

Instal Mesin Fotokopi

Anda dapat menginstal Copier dengan:

pip install copier

Atau lebih baik lagi, jika Anda memiliki pipx , Anda dapat menjalankannya dengan:

pipx install copier

Catatan : Jika Anda memiliki pipx , menginstal mesin fotokopi bersifat opsional, Anda dapat menjalankannya secara langsung.

Hasilkan Proyek Dengan Mesin Fotokopi

Tentukan nama untuk direktori proyek baru Anda, Anda akan menggunakannya di bawah. Misalnya, my-awesome-project .

Buka direktori yang akan menjadi induk proyek Anda, dan jalankan perintah dengan nama proyek Anda:

copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust

Jika Anda memiliki pipx dan belum menginstal copier , Anda dapat menjalankannya secara langsung:

pipx run copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust

Perhatikan bahwa opsi --trust diperlukan untuk dapat menjalankan skrip pasca pembuatan yang memperbarui file .env Anda.

Variabel Masukan

Copier akan menanyakan beberapa data kepada Anda, yang mungkin ingin Anda miliki sebelum membuat proyek.

Tapi jangan khawatir, Anda bisa memperbarui semua itu di file .env setelahnya.

Variabel masukan, dengan nilai defaultnya (beberapa dihasilkan secara otomatis) adalah:

• project_name : (default: "FastAPI Project" ) Nama proyek, ditampilkan kepada pengguna API (dalam .env).
• stack_name : (default: "fastapi-project" ) Nama tumpukan yang digunakan untuk label Docker Compose dan nama proyek (tanpa spasi, tanpa titik) (dalam .env).
• secret_key : (default: "changethis" ) Kunci rahasia untuk proyek, digunakan untuk keamanan, disimpan di .env, Anda dapat membuatnya dengan metode di atas.
• first_superuser : (default: "[email protected]" ) Email pengguna super pertama (dalam .env).
• first_superuser_password : (default: "changethis" ) Kata sandi pengguna super pertama (dalam .env).
• smtp_host : (default: "") Host server SMTP untuk mengirim email, Anda dapat mengaturnya nanti di .env.
• smtp_user : (default: "") Pengguna server SMTP untuk mengirim email, Anda dapat mengaturnya nanti di .env.
• smtp_password : (default: "") Kata sandi server SMTP untuk mengirim email, Anda dapat mengaturnya nanti di .env.
• emails_from_email : (default: "[email protected]" ) Akun email untuk mengirim email, Anda dapat mengaturnya nanti di .env.
• postgres_password : (default: "changethis" ) Kata sandi untuk database PostgreSQL, disimpan di .env, Anda dapat membuatnya dengan metode di atas.
• sentry_dsn : (default: "") DSN untuk Sentry, jika Anda menggunakannya, Anda dapat mengaturnya nanti di .env.

Pengembangan Bagian Belakang

Dokumen backend: backend/README.md.

Pengembangan Bagian Depan

Dokumen frontend: frontend/README.md.

Penyebaran

Dokumen penerapan: deployment.md.

Perkembangan

Dokumen pengembangan umum: development.md.

Ini termasuk penggunaan Docker Compose, domain lokal khusus, konfigurasi .env , dll.

Catatan Rilis

Periksa file catatan rilis.md.

Lisensi

Templat FastAPI Full Stack dilisensikan berdasarkan ketentuan lisensi MIT.