full stack fastapi mongodb

Tumpukan penuh Fastapi, React, MongoDB (Farm) Base Project Generator

Tunjukkan kecintaan Anda pada proyek ini dengan membintangi repo kami ?, Jadi kami dapat terus berinovasi?

Akselerasi proyek pengembangan web Anda berikutnya dengan generator proyek dasar FASTAPI/React/MongoDB ini.

Proyek ini adalah untuk pengembang yang ingin membangun dan memelihara aplikasi web progresif fitur penuh menggunakan Python pada backend / naskah di frontend, dan menginginkan aspek rumit-tapi-rutin dari auth auth, dan konfigurasi komponen dan penyebaran, diurus, termasuk dokumentasi API interaktif.

Ini adalah garpu eksperimental dari Stack Fastapi Fastapi dan PostgreSQL Project Generator dari PostgreSQL dan Stack Fastapi Fastapi dan Generator Proyek Basis PostgreSQL. FASTAPI diperbarui ke versi 0.103.2, motor MongoDB 3.4, ODMantic ODM 1.0.0, dan frontend bereaksi.

Indeks

• Persyaratan
• QuickStart
• Tangkapan layar
• Fitur utama
• Cara menggunakannya
  • Membangun aplikasi yang dihasilkan
  • Pengembangan dan pemasangan
  • Penyebaran untuk produksi
  • Otentikasi dan Token Sihir
  • Websockets untuk komunikasi interaktif
• Lebih detail
• Bantuan yang dibutuhkan
• Catatan Rilis
• Lisensi

Persyaratan

Pastikan Anda menginstal ini sebelum melanjutkan!

• Desktop Docker
• Python 3.11+
• Cookiecutter - Perpustakaan Cookiecutter Python.
• Menetas
• Node.js
• MongoDB Compass - Untuk membantu memvisualisasikan basis data lokal/jarak jauh dengan mudah.

QuickStart

Perhatikan ini akan menghasilkan aplikasi lokal yang belum siap produksi. Silakan melalui semua informasi ReadMe yang ditautkan sebelum membuat versi untuk digunakan ke host produksi

Bagi mereka yang ingin menyelam dan bermain -main dengan kode yang dihasilkan, berikut adalah panduan awal yang cepat tentang cara melakukannya. Disarankan, meskipun, begitu Anda telah menjalankan melalui menghasilkan aplikasi ini pertama kali, Anda melingkari kembali dan memeriksa pembangunan yang lebih disempurnakan di bagian aplikasi yang dihasilkan.

 // Make sure cookiecutter and python are installed on the device
// This will generate a full-stack app in the directory ./example
cookiecutter https://github.com/mongodb-labs/full-stack-fastapi-mongodb --no-input project_name="example"

// Move into that directory.
cd example

// Make sure that you've opened the Docker Desktop app before this step.
// build
docker compose build --no-cache

// start the container in the background
docker compose up -d 

Sekarang Anda dapat melihat situs dengan pergi ke localhost:3000 . Anda juga dapat melihat semua log dari wadah yang berjalan di aplikasi Docker Desktop Anda.

Hanya akan ada satu pengguna di situs: [email protected] . Jika Anda memilih nama proyek yang berbeda, maka domain email berubah. Misalnya, jika Anda membuat proyek Anda menggunakan project_name=fullstackexample email pengguna akan [email protected] . Kata sandi default akan diatur ke changethis tetapi itu dapat diubah.

Berikut semua URL pengembangan lokal:

• Frontend - http: // localhost: 3000
• Backend - http: // localhost/api/v1/
• Dokumentasi Otomatis Melalui Swagger UI - http: // localhost/docs
• Dokumentasi alternatif melalui redoc - http: // localhost/redoc
• Bunga: Alat Admin Tugas Seledri - http: // localhost: 5555
• Traefik UI untuk melihat bagaimana rute ditangani oleh proxy: http: // localhost: 8090

Lihat Membangun aplikasi yang dihasilkan untuk contoh -contoh seperti apa halaman ini.

Fitur utama

Repo MongoDB FASTAPI, React, MongoDB ini akan menghasilkan tumpukan aplikasi web yang lengkap sebagai dasar untuk pengembangan proyek Anda.

• Docker menyusun integrasi dan optimasi untuk pengembangan lokal.
• Skema manajemen pengguna otentikasi , model, CRUD dan API yang sudah dibangun, dengan dukungan token OAuth2 JWT & hashing default. Menawarkan otentikasi tautan ajaib , dengan fallback kata sandi, dengan manajemen cookie, termasuk access dan refresh token.
• Backend Fastapi dengan gambar Docker One-Repo Inboard:
  • Motor mongodb https://motor.readthedocs.io/en/stable/
  • MongoDB Odmantic untuk menangani kreasi ODM https://art049.github.io/odmantic/
  • Dukungan CRUD umum melalui warisan generik.
  • Berbasis Standar : Berdasarkan (dan sepenuhnya kompatibel dengan) Standar Terbuka untuk API: Skema OpenAPI dan JSON.
  • Banyak fitur lainnya : termasuk validasi otomatis, serialisasi, dokumentasi interaktif, dll.
• NextJS/React Frontend:
  • Otorisasi otentikasi berbasis rute, termasuk dukungan untuk mendeteksi jika pengguna masuk atau superuser.
  • Formulir Validasi dengan React Useform
  • Manajemen negara dengan redux
  • CSS dan template dengan tailwindcss, heroicons, dan headlessui.
• Pekerja seledri yang dapat mengimpor dan menggunakan model dan kode dari sisa backend secara selektif.
• Bunga untuk pemantauan pekerjaan seledri.
• Load balancing antara frontend dan backend dengan traefik , sehingga Anda dapat memiliki keduanya di bawah domain yang sama, dipisahkan oleh jalur, tetapi dilayani oleh wadah yang berbeda.
• Integrasi Traefik, termasuk Let's Encrypt HTTPS Sertifikat Generasi Otomatis.
• Gitlab CI (integrasi kontinu), termasuk pengujian frontend dan backend.

Cara menggunakan template

• Membangun aplikasi yang dihasilkan
• Pengembangan dan pemasangan
• Penyebaran untuk produksi
• Otentikasi dan Token Sihir
• Websockets untuk komunikasi interaktif

Lebih detail

Setelah menggunakan generator ini, proyek baru Anda (direktori yang dibuat) akan berisi README.md yang luas dengan instruksi untuk pengembangan, penyebaran, dll. Anda dapat membaca pra-membaca proyek README.md proyek di sini juga.

Rilis saat ini adalah untuk FastAPI versi 0.103 dan memperkenalkan dukungan untuk Pydantic 2. Karena ini dimaksudkan sebagai tumpukan dasar di mana Anda akan membangun aplikasi yang kompleks, tidak ada niat kompatibilitas ke belakang antara rilis, dan tujuannya adalah untuk setiap rilis Anda memiliki versi jangka panjang terbaru dari perpustakaan inti yang mungkin.

Untuk menyelaraskan dengan inboard, puisi telah digunakan untuk Hatch. Ini juga akan, semoga, memilah beberapa kesalahan pembuatan Docker terkait puisi.

Bantuan yang dibutuhkan

Proyek ini saat ini eksperimental, sehingga bug atau masalah dapat terjadi. Harap buka tiket masalah terhadap repositori ini untuk membuat kami mengetahui masalah dan kami akan melakukan yang terbaik untuk menanggapi mereka secara tepat waktu. Silakan tinggalkan umpan balik tentang fitur yang akan sangat bermanfaat bagi pengembang yang sering memanfaatkan MongoDB di Fastapi Stack mereka.

Catatan Rilis

Catatan: Tidak ada niat untuk memiliki kompatibilitas mundur antara rilis.

Lihat catatan:

Calver 2024.01.10

• Penggunaan Beanie yang diganti dengan Odmantic
• Memperbaiki login TOTP
• Menambahkan otentikasi rute tingkat halaman
• Tetap Diterbitkan dengan Pengguna Logged in Not Mampu Mengakses /settings
• Lemparkan kesalahan pada setiap respons non-OK AUTH.TS
• Tetap poject bernama generasi di footer.tsx
• Dihapus rute CORS yang tidak digunakan
• ReadMe yang diperbarui
  • Menambahkan QuickStart
  • Persyaratan tambahan
  • Menambahkan informasi URL Container
• Dokumen yang diperbarui/
  • Ditempatkan docker_example.png
  • Referensi Nuxt dan Beanie yang Di -Hapus
  • Pengindeksan yang diperbarui

Calver 2023.11.10

• Berganti Berikut/Vue.js Frontend Framework dengan React/Redux seluruhnya
• Backend Koneksi asli Backend dari PostgreSQL/SQLALCHEMY DENGAN MOONGODB MOTOR/Beanie ODM
• Plugin NEO4J yang Dihapus
• Penggunaan alembik yang dihapus
• Memperkenalkan variabel lingkungan cookiecutter baru mongodb_uri , dan mongo_database
• Dukungan yang diperkenalkan untuk Pydantic 2

Perubahan Historis dari Perubahan Historis Whythawk dari Asli

Lisensi

Proyek ini dilisensikan berdasarkan ketentuan lisensi MIT.