Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 1.62 KB

ROADMAP.md

File metadata and controls

56 lines (44 loc) · 1.62 KB

Manage FastAPI Roadmap

Hi there! 👋

The package plans are here. If you want to contribute with new ideas, or develop the ones that are listed, read our contributing guidelines! 🤓

Checklist

Must

  • License support on startproject.

  • Docker/Docker-compose support on startproject.

  • Add basic linter tools on startproject (flake8, mypy and isort).

  • Add .pre-commit-config.yaml on startproject.

  • Integrate databases on startproject.

    • SQLALchemy
      • PostgreSQL
      • MySQL
      • SQLite
    • Async SQLAlchemy
      • PostgreSQL
      • MySQL
      • SQLite
    • Gino (only supports PostgreSQL)
    • Tortoise
      • PostgreSQL
      • MySQL
      • SQLite
    • MongoDB
  • Different Authentication support on startproject.

  • Support startapp command.

    • Simple app creation.
    • Append the APIRouter to the FastAPI app.
    • Add --app-file and --app-variable options on startapp.
  • Add tests.

  • Fix documentation accordingly.

  • https://github.com/tortoise/orm-benchmarks

Nice to have

  • VSCode debugger support on startproject (available via docker).
  • Support different CI on startproject.
  • Add support for hypercorn on run.
  • Create migrations/migrate command.
  • Add logger to startproject structure.
  • Base CRUD class to startproject.

Additional

  • Script to copy index.md to README.md and verify if they are the same.

Questions

  • Should we support .git by default?
  • Should CORSMiddleware be optional?