Initial commit

Author: chriscarrollsmith

.env.example

@@ -0,0 +1,6 @@
+SECRET_KEY=
+DB_USER=
+DB_PASSWORD=
+DB_HOST=localhost
+DB_PORT=5432
+DB_NAME=

.gitignore

@@ -0,0 +1,6 @@
+.devcontainer
+.gpteng
+prompt
+__pycache__
+*.pyc
+.env

README.md

@@ -0,0 +1,25 @@
+# FastAPI, Jinja2, PostgreSQL Webapp
+
+This project is still under development.
+
+## Start development database
+
+`docker compose up -d`
+
+## Set environment variables
+
+Copy .env.example to .env with `cp .env.example .env`.
+
+Generate a 256 bit secret key with `openssl rand -base64 32` and paste it into the .env file.
+
+Set your desired database name, username, and password in the .env file.
+
+## Run the development server
+
+`uvicorn main:app --host 0.0.0.0 --port 8000 --reload`
+
+Navigate to http://localhost:8000/
+
+## License
+
+This project is licensed under the GPLv3 License. See the LICENSE file for more details.

docker-compose.yml

@@ -0,0 +1,14 @@
+services:
+  db:
+    image: postgres:latest
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: round_robin_db
+    ports:
+      - "5433:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+
+volumes:
+  postgres_data:

main.py

@@ -0,0 +1,201 @@
+import logging
+from typing import Optional
+from contextlib import asynccontextmanager
+from fastapi import FastAPI, Request, Depends
+from fastapi.responses import RedirectResponse
+from fastapi.staticfiles import StaticFiles
+from fastapi.templating import Jinja2Templates
+from sqlmodel import SQLModel, create_engine
+from fastapi.exceptions import RequestValidationError, StarletteHTTPException
+from routers import auth, organization, score, template, version
+from utils import get_current_user, get_connection_url
+from models import User
+
+
+logger = logging.getLogger("uvicorn.error")
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    # Startup logic
+    engine = create_engine(get_connection_url())
+    SQLModel.metadata.create_all(engine)
+    engine.dispose()
+    yield
+    # Shutdown logic
+
+
+app = FastAPI(lifespan=lifespan)
+
+# Mount static files (e.g., CSS, JS)
+app.mount("/static", StaticFiles(directory="static"), name="static")
+
+# Initialize Jinja2 templates
+templates = Jinja2Templates(directory="templates")
+
+
+@app.exception_handler(StarletteHTTPException)
+async def http_exception_handler(request: Request, exc: StarletteHTTPException):
+    return templates.TemplateResponse(
+        "errors/error.html",
+        {"request": request, "status_code": exc.status_code, "detail": exc.detail},
+        status_code=exc.status_code,
+    )
+
+
+@app.exception_handler(RequestValidationError)
+async def validation_exception_handler(request: Request, exc: RequestValidationError):
+    return templates.TemplateResponse(
+        "errors/error.html",
+        {"request": request, "status_code": 422, "detail": str(exc)},
+        status_code=422,
+    )
+
+
+@app.get("/")
+async def read_home(
+    request: Request,
+    user: Optional[User] = Depends(get_current_user),
+    error_message: Optional[str] = None,
+):
+    if user:
+        return RedirectResponse(url="/dashboard", status_code=302)
+    return templates.TemplateResponse(
+        "index.html", {"request": request, "user": user, "error_message": error_message}
+    )
+
+
+@app.get("/login")
+async def read_login(
+    request: Request,
+    user: Optional[User] = Depends(get_current_user),
+    error_message: Optional[str] = None,
+):
+    if user:
+        return RedirectResponse(url="/dashboard", status_code=302)
+    return templates.TemplateResponse(
+        "authentication/login.html",
+        {"request": request, "user": user, "error_message": error_message},
+    )
+
+
+@app.get("/register")
+async def read_register(
+    request: Request,
+    user: Optional[User] = Depends(get_current_user),
+    error_message: Optional[str] = None,
+):
+    if user:
+        return RedirectResponse(url="/dashboard", status_code=302)
+    return templates.TemplateResponse(
+        "authentication/register.html",
+        {"request": request, "user": user, "error_message": error_message},
+    )
+
+
+@app.get("/forgot_password")
+async def read_forgot_password(
+    request: Request,
+    user: Optional[User] = Depends(get_current_user),
+    error_message: Optional[str] = None,
+):
+    if user:
+        return RedirectResponse(url="/dashboard", status_code=302)
+    return templates.TemplateResponse(
+        "authentication/forgot_password.html",
+        {"request": request, "user": user, "error_message": error_message},
+    )
+
+
+@app.get("/reset_password")
+async def read_reset_password(
+    request: Request,
+    token: str,
+    user: Optional[User] = Depends(get_current_user),
+    error_message: Optional[str] = None,
+):
+    if user:
+        return RedirectResponse(url="/dashboard", status_code=302)
+    # TODO: Validate the token here?
+    return templates.TemplateResponse(
+        "authentication/reset_password.html",
+        {
+            "request": request,
+            "token": token,
+            "user": user,
+            "error_message": error_message,
+        },
+    )
+
+
+@app.get("/dashboard")
+async def read_dashboard(
+    request: Request,
+    user: Optional[User] = Depends(get_current_user),
+    error_message: Optional[str] = None,
+):
+    if not user:
+        return RedirectResponse(url="/", status_code=302)
+    return templates.TemplateResponse(
+        "dashboard/index.html",
+        {"request": request, "user": user, "error_message": error_message},
+    )
+
+
+@app.get("/user_profile")
+async def read_user_profile(
+    request: Request,
+    user: Optional[User] = Depends(get_current_user),
+    error_message: Optional[str] = None,
+):
+    if not user:
+        return RedirectResponse(url="/", status_code=302)
+    return templates.TemplateResponse(
+        "user_profile/index.html",
+        {"request": request, "user": user, "error_message": error_message},
+    )
+
+
+@app.get("/about")
+async def read_about(
+    request: Request,
+    user: Optional[User] = Depends(get_current_user),
+    error_message: Optional[str] = None,
+):
+    return templates.TemplateResponse(
+        "about.html", {"request": request, "user": user, "error_message": error_message}
+    )
+
+
+@app.get("/privacy_policy")
+async def read_privacy_policy(
+    request: Request,
+    user: Optional[User] = Depends(get_current_user),
+    error_message: Optional[str] = None,
+):
+    return templates.TemplateResponse(
+        "privacy_policy.html",
+        {"request": request, "user": user, "error_message": error_message},
+    )
+
+
+@app.get("/terms_of_service")
+async def read_terms_of_service(
+    request: Request,
+    user: Optional[User] = Depends(get_current_user),
+    error_message: Optional[str] = None,
+):
+    return templates.TemplateResponse(
+        "terms_of_service.html",
+        {"request": request, "user": user, "error_message": error_message},
+    )
+
+
+app.include_router(auth.router)
+app.include_router(organization.router)
+
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="0.0.0.0", port=8000)

models.py

@@ -0,0 +1,32 @@
+from sqlalchemy import CheckConstraint
+from sqlmodel import SQLModel, Field, Relationship, Column, Integer
+from typing import Optional, List
+from datetime import datetime, UTC
+
+
+def utc_time():
+    return datetime.now(UTC)
+
+
+class Organization(SQLModel, table=True):
+    id: Optional[int] = Field(default=None, primary_key=True)
+    name: str
+    created_at: datetime = Field(default_factory=utc_time)
+    updated_at: datetime = Field(default_factory=utc_time)
+    deleted: bool = Field(default=False)
+
+    users: List["User"] = Relationship(back_populates="organization")
+
+
+class User(SQLModel, table=True):
+    id: Optional[int] = Field(default=None, primary_key=True)
+    name: str
+    email: str = Field(index=True, unique=True)
+    hashed_password: str
+    avatar_url: Optional[str] = None
+    organization_id: Optional[int] = Field(default=None, foreign_key="organization.id")
+    created_at: datetime = Field(default_factory=utc_time)
+    updated_at: datetime = Field(default_factory=utc_time)
+    deleted: bool = Field(default=False)
+
+    organization: Optional["Organization"] = Relationship(back_populates="users")

pyproject.toml

@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "fastapi-jinja2-postgres-webapp"
+version = "0.1.0"
+description = "A template webapp with a pure-Python FastAPI backend, frontend templating with Jinja2, and a Postgres database to power user auth"
+authors = ["Christopher Carroll Smith <[email protected]>"]
+readme = "README.md"
+package-mode = false
+
+[tool.poetry.dependencies]
+python = "^3.12"
+sqlmodel = "^0.0.22"
+mypy = "^1.11.2"
+fastapi = "^0.114.1"
+passlib = {extras = ["bcrypt"], version = "^1.7.4"}
+pyjwt = "^2.9.0"
+jinja2 = "^3.1.4"
+uvicorn = "^0.30.6"
+psycopg2 = "^2.9.9"
+pydantic = {extras = ["email"], version = "^2.9.1"}
+python-multipart = "^0.0.9"
+python-dotenv = "^1.0.1"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"