full stack fastapi mongodb

Générateur de projets de base Fullapi Fastapi, React, MongoDB (ferme)

Montrez votre amour pour ce projet en mettant en vedette notre dépôt?, Afin que nous puissions continuer à innover?

Accélérez votre prochain projet de développement Web avec ce générateur de projet de base Fastapi / React / MongoDB.

Ce projet est destiné aux développeurs qui cherchent à construire et à maintenir des applications Web progressives complètes à l'aide de Python sur le backend / dactylographie sur le frontend, et souhaitent les aspects complexes mais routine de l'auth 'n auth, et la configuration des composants et du déploiement, pris en charge, y compris la documentation interactive de l'API.

Il s'agit d'une fourche expérimentale du générateur de projet de base Full Stack Fastapi et Postgresql de Sébastián Ramírez et du générateur de projet de base Full Stack Fastapi et PostgreSQL de Whythawk. FastAPI est mis à jour vers la version 0.103.2, le moteur MongoDB 3.4, l'ODMANTIC ODM 1.0.0 et le frontend to React.

Indice

• Exigences
• Start
• Captures d'écran
• Caractéristiques clés
• Comment l'utiliser
  • Construire une application générée
  • Développement et installation
  • Déploiement pour la production
  • Authentification et jetons magiques
  • Websockets pour la communication interactive
• Plus de détails
• Aide nécessaire
• Notes de libération
• Licence

Exigences

Assurez-vous que vous les avez installés avant de continuer!

• Docker Desktop
• Python 3.11+
• Cookiecetter - La bibliothèque Python Cookietter.
• Trappe
• Node.js
• MongoDB Compass - pour aider à visualiser facilement la base de données locale / distante.

Start

Remarque Cela générera une application locale qui n'est pas encore prête pour la production. Veuillez passer par toutes les informations ReadMe liées avant de créer une version à déployer sur un hôte de production

Pour ceux qui veulent plonger et jouer avec le code généré, voici un guide de démarrage rapide sur la façon de le faire. Il est conseillé, cependant, une fois que vous avez exécuté la génération de cette application la première fois, que vous tournez en arrière et consultez les plus étoffés en construisant une section d'application générée.

 // 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 

Vous pouvez maintenant consulter le site en allant à localhost:3000 . Vous pouvez également voir tous les journaux des conteneurs en cours d'exécution dans votre application Docker Desktop.

Il n'y aura qu'un seul utilisateur sur le site: [email protected] . Si vous choisissez un nom de projet différent, le domaine des e-mails change. Par exemple, si vous créez votre projet à l'aide de project_name=fullstackexample l'e-mail utilisateur sera [email protected] . Le mot de passe par défaut sera défini sur changethis mais cela peut être modifié.

Voici toutes les URL de développement local:

• Frontend - http: // localhost: 3000
• Backend - http: // localhost / api / v1 /
• Documentation automatique via Swagger UI - http: // localhost / docs
• Documentation alternative via redoc - http: // localhost / redoc
• Fleur: outil d'administration des tâches de céleri - http: // localhost: 5555
• Trafik UI pour voir comment les itinéraires sont gérés par le proxy: http: // localhost: 8090

Voir la construction d'une application générée pour des exemples de ce à quoi ressemblent ces pages.

Caractéristiques clés

Ce repo Fastapi, React, MongoDB générera une pile d'applications Web complète comme base pour le développement de votre projet.

• Docker compose l'intégration et l'optimisation pour le développement local.
• Authentification Schémas de gestion des utilisateurs, modèles, crud et API déjà construits, avec la prise en charge du jeton OAuth2 JWT et le hachage par défaut. Offre l'authentification Magic Link , avec un rendement du mot de passe, avec la gestion des cookies, y compris les jetons access et refresh .
• Backend Fastapi avec des images Docker à une repo intérieure:
  • MONGODB MOTOR https://motor.readthedocs.io/en/stable/
  • MongoDB Odmantic pour la gestion de la création ODM https://art049.github.io/odmantic/
  • Support CRUD commun via l'héritage générique.
  • Normes basées sur : basées sur (et entièrement compatible avec) les normes ouvertes pour les API: OpenAPI et le schéma JSON.
  • De nombreuses autres fonctionnalités : y compris la validation automatique, la sérialisation, la documentation interactive, etc.
• NextJS / React Frontend:
  • Authentification basée sur l'itinéraire d'autorisation , y compris la prise en charge de la détection si un utilisateur est connecté ou est un superutilisateur.
  • Validation du formulaire avec React Useform
  • Gestion de l'État avec redux
  • CSS et modèles avec tailwindcss, héroïcons et headlessui.
• Travailleur de céleri qui peut importer et utiliser des modèles et du code du reste du backend sélectivement.
• Fleur pour la surveillance des emplois de céleri.
• Équilibrage de charge entre frontend et backend avec Trafik , vous pouvez donc avoir les deux sous le même domaine, séparés par chemin, mais servi par différents conteneurs.
• Intégration Trafik, y compris Let's Crypt Certificats HTTPS Génération automatique.
• GitLab CI (intégration continue), y compris les tests frontend et backend.

Comment utiliser le modèle

• Construire une application générée
• Développement et installation
• Déploiement pour la production
• Authentification et jetons magiques
• Websockets pour la communication interactive

Plus de détails

Après avoir utilisé ce générateur, votre nouveau projet (le répertoire créé) contiendra un vaste README.md avec des instructions pour le développement, le déploiement, etc. Vous pouvez également prévoir le modèle README.md Project ici.

Cette version actuelle concerne FastAPI version 0.103 et introduit la prise en charge de Pyndantic 2. Étant donné que cela est destiné à une pile de base sur laquelle vous construirez des applications complexes, il n'y a aucune intention de compatibilité rétrograde entre les versions, et l'objectif est de vous assurer que chaque version a les dernières versions à long terme des versions de base des libraires de base afin que vous puissiez relever votre application au cœur que possible.

Pour s'aligner sur l'intégration, la poésie a été obsolète en faveur de Hatch. Cela triera également, espérons-le, certaines erreurs de construction docker liées à la poésie.

Aide nécessaire

Ce projet est actuellement expérimental, donc des bogues ou des problèmes peuvent survenir. Veuillez ouvrir un billet de problème contre ce référentiel pour nous faire prendre conscience des problèmes et nous ferons de notre mieux pour les répondre en temps opportun. Veuillez laisser des commentaires sur les fonctionnalités qui seraient très bénéfiques pour les développeurs qui exploitent souvent MongoDB dans leur pile Fastapi.

Notes de libération

Remarque: il n'y a aucune intention d'avoir une compatibilité en arrière entre les versions.

Voir les notes:

Calver 2024.01.10

• Utilisation du bonnet remplacé par Odmantic
• Connexion TOTP fixe
• Ajout d'authentification de l'itinéraire au niveau de la page
• Correction émise avec une page de page connectée à l'utilisateur n'étant pas en mesure d'accès /settings
• Jetez des erreurs sur chaque réponse non ok.ts
• POJECT COMME NAGME GÉNÉRATION DANS LE FOOD.TSX
• Suppression des voies de COR inutilisées
• Readme mis à jour
  • Ajout de QuickStart
  • Exigences supplémentaires
  • Informations sur l'URL du conteneur ajouté
• Docs mis à jour /
  • Placé docker_example.png
  • Références en suppression persistante de Nuxx et de bonnet
  • Indexation mise à jour

Calver 2023.11.10

• Remplacé Suivant / Vue.js Frontend Framework entièrement réagi / redux
• Remplacé Connexion native du backend de PostgreSQL / SQLALCHEMY AVEC MOTEUR MONGODB / BEAIE ODM
• Plugin NEO4J supprimé
• Utilisation alembique supprimée
• Introduit de nouveaux variables d'environnement de cuisine mongodb_uri et mongo_database
• Prise en charge introduite pour Pyndantic 2

Changements historiques par rapport aux changements historiques de Whythawk par rapport à l'original

Licence

Ce projet est concédé sous licence de la licence du MIT.