Accelerate your next web development project with this FastAPI/Nuxt.js 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 a comprehensively updated fork of Sebastián Ramírez's Full Stack FastAPI and PostgreSQL Base Project Generator. FastAPI is updated to version 0.99 (July 2023), SQLAlchemy to version 2.0 (July 2023), and the frontend to Nuxt 3.6 (July 2023).

• Screenshots
• Key features
• How to use it
  • Getting started
  • Development and installation
  • Deployment for production
  • Authentication and magic tokens
  • Websockets for interactive communication
• 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. Offers magic link authentication, with password fallback, with cookie management, including access and refresh tokens.
• FastAPI backend with Inboard one-repo Docker images:
  • SQLAlchemy version 2.0 support for models.
  • MJML templates for common email transactions.
  • Metadata Schema based on Dublin Core for inheritance.
  • Common CRUD support via generic inheritance.
  • Standards-based: Based on (and fully compatible with) the open standards for APIs: OpenAPI and JSON Schema.
  • Many other features: including automatic validation, serialization, interactive documentation, etc.
• Nuxt/Vue 3 frontend:
  • Authorisation via middleware for page access, including logged in or superuser.
  • Model blog project, with Nuxt Content for writing Markdown pages.
  • Form validation with Vee-Validate 4.
  • State management with Pinia, and persistance with Pinia PersistedState.
  • CSS and templates with TailwindCSS, HeroIcons, and HeadlessUI.
  • Internationalisation with @nuxt/i18n.
  • PWA support with Vite PWA plugin.
• 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 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.

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

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 (August 2023) is for FastAPI version 0.99 and is the last before introducing 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.

You will also find an initial implementation of internationalisation using @nuxt/i18n. This is - at this time - a release candidate, so please do update and check their documentation for any changes. The Vite 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 the nuxt.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 and releases.

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 for build.

• Updates to frontend, #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 of robots.txt permissions from nuxt.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 and celeryworker:
    • 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.