robot-u-site/README.md
2026-04-08 06:14:06 -04:00

1.1 KiB

Robot U Site Prototype

Thin frontend layer over Forgejo for community learning content, discussions, and events.

Stack

  • FastAPI backend
  • Preact + TypeScript frontend built with Vite
  • bun for frontend tooling
  • uv + ruff for Python checks

Local Development

Backend

python3 -m venv .venv
.venv/bin/pip install -r requirements.txt
.venv/bin/python -m uvicorn app:app --reload

Start App

Build the frontend and then serve the app from FastAPI:

./scripts/start.sh

The script automatically loads .env and .env.local if present.

Optional runtime overrides:

HOST=0.0.0.0 PORT=8800 ./scripts/start.sh

Optional live Forgejo configuration:

export FORGEJO_BASE_URL="https://aksal.cloud"
export FORGEJO_TOKEN="your-forgejo-api-token"
export CALENDAR_FEED_URLS="webcal://example.com/calendar.ics,https://example.com/other.ics"

Or put those values in .env:

cp .env.example .env

Frontend

cd frontend
~/.bun/bin/bun install
~/.bun/bin/bun run dev

Quality Checks

./scripts/check_python_quality.sh
./scripts/check_frontend_quality.sh