Skip to content

Latest commit

 

History

History
161 lines (116 loc) · 8.99 KB

README.md

File metadata and controls

161 lines (116 loc) · 8.99 KB
Raw

Full Stack FastAPI, React, MongoDB (FARM) Base Project Generator

Show your love for this project by starring our repo 🌟, so we can continue to innovate 🙂

Accelerate your next web development project with this FastAPI/React/MongoDB base project generator.

This project is for developers looking to build and maintain full-feature progressive web applications using Python on the backend / Typescript on the frontend, and want the complex-but-routine aspects of auth 'n auth, and component and deployment configuration, taken care of, including interactive API documentation.

This is an experimental fork of Sebastián Ramírez's Full Stack FastAPI and PostgreSQL Base Project Generator and Whythawk's Full Stack FastAPI and PostgreSQL Base Project Generator. FastAPI is updated to version 0.103.2, MongoDB Motor 3.4, ODMantic ODM 1.0.0, and the frontend to React.

Landing page

Index

Requirements

Please make sure you have these installed before proceeding!

QuickStart

NOTE This will generate a local application that is not yet production-ready. Please go through all of the README information linked before creating a version to deploy to a production host

For those that want to dive in and play around with the generated code, here's a quick start guide on how to do it. It is advised, though, once you have run through generating this app the first time, that you circle back and check out the more fleshed out Building a generated app section.

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

Now you can view the site by going to localhost:3000. You can also see all the logs of the running containers in your Docker Desktop app.

There will only be one user on the site: admin@example.com. If you choose a different project name, then the email domain changes. For example, if you create your project usingproject_name=fullstackexample the user email will be admin@fullstackexample.com. The default password will be set to changethis but that can be changed.

Here are all the local development URLS:

See Building a generated app for examples of what these pages look like.

Key features

This FastAPI, React, MongoDB repo will generate a complete web application stack as a foundation for your project development.

  • Docker Compose integration and optimization for local development.
  • Authentication user management schemas, models, crud and apis already built, with OAuth2 JWT token support & default hashing. Offers magic link authentication, with password fallback, with cookie management, including access and refresh tokens.
  • FastAPI backend with Inboard one-repo Docker images:
  • Nextjs/React frontend:
    • Authorization route-based authentication, including support for detecting if a user is logged in or is a superuser.
    • Form validation with React useForm
    • State management with Redux
    • CSS and templates with TailwindCSS, HeroIcons, and HeadlessUI.
  • Celery worker that can import and use models and code from the rest of the backend selectively.
  • Flower for Celery jobs monitoring.
  • Load balancing between frontend and backend with Traefik, so you can have both under the same domain, separated by path, but served by different containers.
  • Traefik integration, including Let's Encrypt HTTPS certificates automatic generation.
  • GitLab CI (continuous integration), including frontend and backend testing.

How to use the template

More details

After using this generator, your new project (the directory created) will contain an extensive README.md with instructions for development, deployment, etc. You can pre-read the project README.md template here too.

This current release is for FastAPI version 0.103 and introduces support for Pydantic 2. Since this is intended as a base stack on which you will build complex applications, there is no intention of backwards compatability between releases, and the objective is to ensure that each release has the latest long-term-support versions of the core libraries so that you can rely on your application core for as long as possible.

To align with Inboard, Poetry has been deprecated in favour of Hatch. This will also, hopefully, sort out some Poetry-related Docker build errors.

Help needed

This project is currently experimental, so bugs or issues may occur. Please open an issue ticket against this repository to make us aware of issues and we will do our best to respond to them in a timely manner. Please leave feedback on features that would be very beneficial for developers who often leverage MongoDB in their FastAPI stack.

Release Notes

NOTE: There is no intention to have backwards compatibility between releases.

See notes:

CalVer 2024.01.10

  • Replaced Beanie usage with ODMantic
  • Fixed TOTP login
  • Added Page-Level route authentication
  • Fixed issued with logged in user being unable to access /settings page
  • Throw errors on every non-ok auth.ts response
  • Fixed Poject Named generation in Footer.tsx
  • Removed unused CORS routes
  • Updated README
    • Added QuickStart
    • Added Requirements
    • Added Container URL Information
  • Updated docs/
    • Placed docker_example.png
    • Removed lingering Nuxt and Beanie references
    • Updated Indexing

CalVer 2023.11.10

  • Replaced Next/Vue.js frontend framework with entirely React/Redux
  • Replaced Backend native connection of PostgreSQL/SQLAlchemy with MongoDB Motor/Beanie ODM
  • Removed Neo4j plugin
  • Removed Alembic Usage
  • Introduced new cookiecutter environment variables mongodb_uri, and mongo_database
  • Introduced support for Pydantic 2

Historic changes from whythawk Historic changes from original

License

This project is licensed under the terms of the MIT license.