Merge pull request #5 from TheRealDarkCoder/chore/repo-setup

Chore/repo setup

Author: TheRealDarkCoder

.env.example

@@ -0,0 +1,101 @@
+# ============================================================================
+# Routis Environment Configuration
+# ============================================================================
+# Copy this file to .env and fill in your values.
+# For local development, the defaults below are safe.
+# For production, use strong, unique values and never commit the actual .env file.
+
+# ============================================================================
+# Application Environment
+# ============================================================================
+
+# deployment environment: development, staging, production
+APP_ENV=development
+
+# ============================================================================
+# Database (PostgreSQL)
+# ============================================================================
+
+# PostgreSQL connection string
+# Format: postgresql://username:password@host:port/database
+# Local dev: use "postgres" hostname (Docker service name)
+# Production: use managed RDS endpoint or external host
+DATABASE_URL=postgresql://postgres:postgres@postgres:5432/routis
+
+# PostgreSQL credentials (used by docker-compose for initialization)
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_DB=routis
+
+# ============================================================================
+# Cache & Rate Limiting (Redis)
+# ============================================================================
+
+# Redis connection URL
+# Format: redis://[password@]host:port/[db]
+# Local dev: use "redis" hostname (Docker service name)
+# Production: use ElastiCache endpoint or external Redis host
+REDIS_URL=redis://redis:6379/0
+
+# ============================================================================
+# Security & Anonymity
+# ============================================================================
+
+# Secret salt for email verification hashing
+# Used in: SHA256(email + implementation_id + SECRET_SALT)
+# Must be a long, random, secret string
+# Generate: openssl rand -hex 32
+SECRET_SALT=your-secret-salt-change-this-in-production-never-commit-the-real-value
+
+# ============================================================================
+# AWS S3 (Database Backups)
+# ============================================================================
+
+# S3 bucket name for database backups
+# Bucket should have versioning and object lock enabled
+# See: docs/runbooks/restore-db.md
+S3_BACKUP_BUCKET=routis-db-backups-prod
+
+# AWS access credentials (for db-backup sidecar container)
+# DO NOT commit these to version control
+# Use IAM roles in production, or AWS Secrets Manager
+AWS_ACCESS_KEY_ID=your-aws-access-key-id
+AWS_SECRET_ACCESS_KEY=your-aws-secret-access-key
+
+# AWS region for S3 operations
+AWS_REGION=eu-west-1
+
+# Backup retention policy
+# Daily backups retained for N days; weekly backups for N weeks
+S3_BACKUP_RETENTION_DAYS=30
+S3_BACKUP_RETENTION_WEEKS=26
+
+# ============================================================================
+# Frontend (Next.js)
+# ============================================================================
+
+# Public API URL (exposed to browser)
+# Local dev: http://localhost:8000
+# Production: https://api.yourdomain.com
+NEXT_PUBLIC_API_URL=http://localhost:8000
+
+# ============================================================================
+# Email Verification (Future)
+# ============================================================================
+
+# Email provider credentials (stub for now)
+# SMTP_HOST=smtp.example.com
+# SMTP_PORT=587
+# SMTP_USER=noreply@routis.local
+# SMTP_PASSWORD=your-email-password
+
+# Email domain whitelist (comma-separated)
+# Only @student.oulu.fi addresses can verify reviews
+ALLOWED_EMAIL_DOMAINS=student.oulu.fi
+
+# ============================================================================
+# Feature Flags (Future)
+# ============================================================================
+
+# ENABLE_EMAIL_VERIFICATION=false
+# ENABLE_LEADERBOARD=true

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,17 @@
+---
+name: Bug
+about: Something is broken
+labels: type/bug
+---
+
+**What happened**
+<!-- What did you do, what did you expect, what actually occurred? -->
+
+**To reproduce**
+<!-- Minimal steps. -->
+
+**Environment**
+<!-- Local / staging / prod. Browser or API. Relevant versions. -->
+
+**Notes**
+<!-- Logs, screenshots, or leave blank. -->

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,17 @@
+---
+name: Feature
+about: A new capability or improvement
+labels: type/feature
+---
+
+**What and why**
+<!-- One or two sentences. What does this do and why does it matter? -->
+
+**Milestone**
+<!-- M0 / M1 / M2 / M3 / M4 / M5 -->
+
+**Done when**
+<!-- The specific, verifiable condition that closes this issue. -->
+
+**Notes**
+<!-- Implementation hints, constraints, links to ADRs, or leave blank. -->

.github/pull_request_template.md

@@ -0,0 +1,12 @@
+Closes #<!-- issue number -->
+
+**What changed**
+<!-- One paragraph. Why this approach? -->
+
+**Checklist**
+- [ ] Linked issue above
+- [ ] `docker compose up` works locally
+- [ ] Tests added or existing tests cover this (or N/A)
+- [ ] Migration included if schema changed
+- [ ] `schema.dbml` updated if schema changed
+- [ ] Codegen re-run if API routes or schemas changed

.github/workflows/ci.yml

@@ -0,0 +1,72 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main, develop]
+  push:
+    branches: [develop]
+
+jobs:
+  web:
+    name: Web
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: apps/web
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+          cache-dependency-path: apps/web/package-lock.json
+
+      - run: npm ci
+
+      - run: npm run lint
+
+      - run: npm run build
+
+  api:
+    name: API
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: apps/api
+
+    services:
+      postgres:
+        image: postgres:18-alpine
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: routis_test
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: apps/api/uv.lock
+
+      - run: uv sync --frozen
+
+      - run: uv run ruff check .
+
+      - run: uv run ruff format --check .
+
+      - name: Pytest
+        run: uv run pytest
+        env:
+          DATABASE_URL: postgresql://postgres:postgres@localhost:5432/routis_test
+          REDIS_URL: redis://localhost:6379

.github/workflows/cla.yml

@@ -17,5 +17,5 @@ jobs:
         with:
           path-to-signatures: "signatures/version1/cla.json"
           path-to-document: "https://github.com/TheRealDarkCoder/Routis/blob/main/docs/CLA.md" # IMPORTANT: Update this URL!
-          branch: "main"
+          branch: "signatures"
           allowlist: dependabot[bot],greenkeeper[bot]

README.md

@@ -0,0 +1,72 @@
+# 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
+
+```bash
+cp .env.example .env
+docker compose up
+```
+
+- Web: http://localhost:3000
+- API: http://localhost:8000
+- API docs: http://localhost:8000/docs
+
+## 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:**
+
+```bash
+cd apps/web
+npm ci
+npm run dev
+```
+
+**Backend:**
+
+```bash
+cd apps/api
+uv sync
+uv run fastapi dev main.py
+```
+
+**Lint & Test:**
+
+```bash
+# Frontend
+cd apps/web && npm run lint
+
+# Backend
+cd apps/api && ruff check . && ruff format --check . && uv run pytest
+```
+
+## Documentation
+
+- [Architecture](docs/ARCHITECTURE.md)
+- [Architecture Decision Records](docs/decisions/)
+- [Runbooks](docs/runbooks/)
+
+## License
+
+[AGPL-3.0](COPYING)

apps/api/.python-version

@@ -0,0 +1 @@
+3.13

apps/api/Dockerfile

@@ -0,0 +1,26 @@
+FROM python:3.13-slim
+
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc \
+    postgresql-client \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install uv
+RUN pip install --no-cache-dir uv
+
+# Copy dependency files
+COPY pyproject.toml uv.lock ./
+
+# Install dependencies
+RUN uv sync --frozen --no-dev
+
+# Copy application code
+COPY . .
+
+EXPOSE 8000
+
+# Use uv run to execute through the virtual environment
+CMD ["uv", "run", "uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]