Repository files navigation

Accelerate your next web development project with this FastAPI/NuxtJS 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 project is a fork ofSebastián Ramírez'sFull Stack FastAPI and PostgreSQL Base Project Generator. FastAPI is updated to version 0.109 (April 2024), SQLAlchemy to version 2.0.29 (March 2024), and the frontend to Nuxt 3.11 (April 2024).

• Key features
• Screenshots
• How to use it
  • Getting started
  • Development and installation
  • Deployment for production
  • Authentication and magic tokens
  • Websockets for interactive communication
• Fork differences
• More details
• Help needed
• Release notes
• License

This FastAPI, PostgreSQL, Neo4j & Nuxt 3 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. Offersmagic link authentication, with password fallback, with cookie management, includingaccess andrefresh tokens.
• FastAPI backend withInboard one-repo Docker images, using Python 3.11:
  • SQLAlchemy version 2.0 support for models.
  • Pydantic version 2.7 for schemas.
  • Metadata Schema based onDublin Core for inheritance.
  • Common CRUD support via generic inheritance.
  • Standards-based: Based on (and fully compatible with) the open standards for APIs:OpenAPI andJSON Schema.
  • MJML templates for common email transactions.
  • Many other features: including automatic validation, serialization, interactive documentation, etc.
• Nuxt/Vue 3 frontend using TypeScript:
  • Authorisation via middleware for page access, including logged in or superuser.
  • Model blog project, withNuxt Content for writing Markdown pages.
  • Form validation withVee-Validate 4.
  • State management withPinia, and persistance withPinia PersistedState.
  • CSS and templates withTailwindCSS,HeroIcons, andHeadlessUI.
• PostgreSQL database.
• PGAdmin for PostgreSQL database management.
• Celery worker that can import and use models and code from the rest of the backend selectively.
• Flower for Celery jobs monitoring.
• Neo4j graph database, including integration into the FastAPI base project.
• Load balancing between frontend and backend withTraefik, so you can have both under the same domain, separated by path, but served by different containers.
• Traefik integration, including Let's EncryptHTTPS certificates automatic generation.

• Getting started
• Development and installation
• Deployment for production
• Authentication and magic tokens
• Websockets for interactive communication

The original objective of this fork was to maintain parity with theFull Stack FastAPI and PostgreSQL Base Project Generator but update it to bring it up to current stack versions, fixes, and with a complete auth 'n auth system.

With the most recent updates to the base stack, Sebastián has made some fairly dramatic changes and these two stacks are no longer compatible. This table presents a summary of the major differences:

I use this stack to produce some fairly complex web-based applications and I need to get to the full APIs for SQLAlchemy and Pydantic, and SqlModel doesn't offer me that. I also need to run distributed asyncronous tasks, so Celery is important. Finally, I prefer Nuxt.

This stack also has a much more sophisticated and feature-complete auth 'n auth system which is a requirement for any web app.

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

This current release (May 2024) is for FastAPI version 0.109 introduces support for Pydantic 2.7. 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 withInboard, Poetry has been deprecated in favour ofHatch.

You will also find an initial implementation of internationalisation using@nuxt/i18n. TheVite PWA plugin is also included, along with a Node CLI for generating all necessary app icons. You will see links and notes to this in thenuxt.config.ts file.

The tests are broken and it would be great if someone could take that on. Other potential roadmap items:

• Translation: docs are all in English and it would be great if those could be in other languages.
• Internationalisation:nuxt/i18n is added, but the sample pages are not all translated.
• Code review and optimisation: both the front- and backend stacks have seen some big generational changes, so would be good to have more eyes on the updates to this stack.

See notes andreleases.

Updates tobackend:

• FastAPI 0.99 -> 0.109 (Inboard 0.51 -> 0.68)
• Pydantic 1.10 -> 2.7.1

Updates tofrontend:

• NuxtJS 3.6.5 -> 3.11.2
• Nuxtjs i18n 8.0.0 RC -> 8.3.1

The Pydantic change is dramatic, so please revise theirmigration guide. Similarly,nuxt/i18n has some major quality of life improvements.

Fixing#39, thanks to @a-vorobyoff:

• Exposing port 24678 for Vite on frontend in development mode.
• Ensuring Nuxt content on /api/_content doesn't interfere with backend /api/v routes.
• Checking for password before hashing on user creation.
• Updating generated README for Hatch (after Poetry deprecation).
• Minor fixes.

• Minor updates to Docker scripts forbuild.

• Updates tofrontend,#37 by @turukawa:
  • @nuxtjs/i18n for internationalisation, along with language selection component.
  • @vite-pwa/nuxt along with button components for install and refreshing the app and service workers, and a CLI icon generator.
  • @nuxtjs/robots for simple control ofrobots.txt permissions fromnuxt.config.ts.

• Updates: Complete update of stack to latest long-term releases.#35 by @turukawa, review by @br3ndonland
  • frontend:
    • Node 16 -> 18
    • Nuxt 3.2 -> 3.6.5
    • Latest Pinia requires changes in stores, where imports are not required (cause actual errors), and parameter declaration must happen in functions.
  • backend andceleryworker:
    • Python 3.9 -> 3.11
    • FastAPI 0.88 -> 0.99 (Inboard 0.37 -> 0.51)
    • Poetry -> Hatch
    • Postgres 14 -> 15
• Fixed: Updated token url in deps.py#29 by @vusa
• Docs: Reorganised documentation#21 by @turukawa

Historic changes from original

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