README.md

Karr

The federated carpool platform

Karr: Car in Breton language. Not a misspelling ;)

Built with:

• @karr/api: Hono, Drizzle, TypeScript, Postgres (Docker package)
• @karr/web: Next.js (Docker package)
• @karr/caddy: Caddy server (Docker package)
• @karr/auth: Ory Kratos + Oathkeeper (or OpenAuth)

PoC Roadmap

Target: get a basic "fake" demo working

Web

• Build login
• Show all trips on instance
• Build "add trip" UI
• Show federated trips

Optional:

• show number of trips on account page

API

• Build mock login
• Return mock trips
• Add federation module for federation-specific routes

Roadmap

• Carpool platform with recurring trips
• Admin dashboard for instance piloting
• Federate instances for shared trips
• Calculate the carbon footprint of a trip (total and per person)

TODO

• Get deployment working

  • Get Tailwind included working in production build
  • Get automatic build working
  • Deploy automatically (Directly in GH actions, inspired from Zenstats)
  • Add versioning (Changesets)

• Add zod validation in Hono (Hono docs)

  • Env type-safety T3 env

• Add mock login

  • Use clsx ?
  • Add i18n info in Nextjs docs

• Add trip search route that gives fake, not-searched data

• Add demo client for PoC

• Minify API Docker container

• Get auth server running (using Ory Kratos/Oathkeeper, with JWT)

• Build proper auth frontend

• Add tests

  • config
  • util
  • api
  • ui
  • web
  • caddy (SITE_ADDRESS=localhost API_PORT=1993 WEB_PORT=3000 caddy validate --config Caddyfile)

• Add documentation