Skip to content

README.md

Latest commit

 

History

History
74 lines (53 loc) · 1.37 KB

README.md

File metadata and controls

74 lines (53 loc) · 1.37 KB
Raw

Routis

Anonymous course review platform for the University of Oulu. Students can submit reviews of courses without creating an account, with optional email-based verification for added credibility.

Tech Stack

  • Frontend: Next.js 16, React 19, Tailwind CSS 4, TypeScript
  • Backend: FastAPI, SQLAlchemy, Pydantic v2, Python 3.13
  • Database: PostgreSQL 18, Alembic (migrations)
  • Cache: Redis 7
  • Infrastructure: Docker Compose

Getting Started

Read Contributing Guidelines

cp .env.example .env
docker compose up

Project Structure

apps/
  web/          # Next.js frontend
  api/          # FastAPI backend
packages/
  shared/       # Shared schemas & generated types
docs/           # Architecture docs, ADRs, runbooks
infra/          # Deployment config

Development

Frontend:

cd apps/web
npm ci
npm run dev

Backend:

cd apps/api
uv sync
uv run fastapi dev main.py

Lint & Test:

# Frontend
cd apps/web && npm run lint

# Backend
cd apps/api && ruff check . && ruff format --check . && uv run pytest

Documentation

License

AGPL-3.0