Merge pull request #135 from GetTechAPI/chore/cleanup-leftovers

chore: correct the landing site, the development guide and repository metadata

Author: Seungpyo1007

.env.example

@@ -5,11 +5,6 @@
 DATABASE_URL=sqlite:///./techapi.db
 DATABASE_POOL_SIZE=10
 
-# === Supabase (production Postgres host) ===
-SUPABASE_URL=https://xxx.supabase.co
-SUPABASE_ANON_KEY=eyJ...
-SUPABASE_SERVICE_KEY=eyJ...   # secret, never expose to clients
-
 # === API ===
 API_HOST=0.0.0.0
 API_PORT=8000
@@ -22,10 +17,6 @@ CORS_ORIGINS=http://localhost:3000,https://techpicks.app
 
 # === Logging ===
 LOG_LEVEL=INFO
-SENTRY_DSN=https://...        # optional
-
-# === External Services ===
-REDIS_URL=redis://localhost:6379    # optional (Phase 2+)
 
 # === Scoring ===
 SCORING_CONFIG_PATH=./config/scoring.yaml

.github/CODEOWNERS

@@ -1,4 +1,2 @@
-# Default owners for everything in the repo.
-* @GetTechAPI/maintainers
-
-/app/       @GetTechAPI/maintainers
+# Default owner for everything in the repo.
+* @Seungpyo1007

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,5 +1,5 @@
 name: "🐛 Bug report"
-description: Report a bug in the API or tooling
+description: Report a bug in the validator, API server, dump generator, collectors or verification
 labels: ["type:bug"]
 body:
   - type: textarea
@@ -13,9 +13,10 @@ body:
     id: reproduce
     attributes:
       label: Steps to reproduce
-      description: Include the exact request (curl) where possible.
+      description: Include the exact command or request, and the TechEngine commit you ran.
       placeholder: |
-        curl https://api.techapi.dev/v1/smartphones/galaxy-s25
+        python -m app.validate
+        curl http://localhost:8000/v1/smartphones/galaxy-s25
     validations:
       required: true
   - type: textarea
@@ -28,4 +29,4 @@ body:
     id: request-id
     attributes:
       label: request_id (if any)
-      description: The `request_id` from the error response helps us trace it.
+      description: For API errors, the `request_id` from the error response.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Missing or incorrect data
+    url: https://github.com/GetTechAPI/TechAPI/issues/new/choose
+    about: This repository holds no data. Report a missing record or a wrong value in the TechAPI repository.
+  - name: Video games
+    url: https://github.com/GetTechAPI/game-catalog/issues
+    about: Game records live in the game-catalog repository.

.github/ISSUE_TEMPLATE/data_addition.yml

@@ -23,15 +23,12 @@ env/
 # TECHAPI_DATA_DIR); the dataset is never committed here.
 /TechAPI/
 
-# Generated static dump (build artifact; published by refresh-data workflow)
+# Generated static dump (build artifact; deploy-pages.yml publishes it)
 /dump/
 
 # Local-only handoff notes (private; never committed to the public repo)
 *.local.md
 
-# Note: data/_staging/ (raw collected candidate pool) is intentionally tracked —
-# comprehensive data collection is a purpose of this repo.
-
 # Local Wikipedia GPU backfill cache and dry-run reports (never a TechAPI write)
 .wikipedia-gpu-backfill/
 
@@ -55,6 +52,3 @@ coverage.xml
 
 # Local Wikipedia SoC backfill cache and reports (never commit)
 .wikipedia-soc-backfill/
-
-# Recomputable verifier cache
-/data/_verify/state/

.github/ISSUE_TEMPLATE/data_correction.yml

@@ -11,9 +11,10 @@ COPY pyproject.toml README.md ./
 COPY app ./app
 RUN pip install --no-cache-dir .
 
-# Runtime assets.
-COPY data ./data
-COPY scripts ./scripts
+# Runtime assets. The dataset is not part of the image: mount a TechAPI
+# checkout's data/ at /data (see docker-compose.yml).
+COPY config ./config
+ENV TECHAPI_DATA_DIR=/data
 
 # Run as a non-root user.
 RUN useradd --create-home --uid 10001 appuser \

.gitignore

@@ -39,7 +39,7 @@ tests/                 # unit/, integration/, verify/
 site/                  # Astro landing page, deployed to GitHub Pages
 docs/                  # SPEC, DATA_PIPELINE, DEVELOPMENT
 .github/workflows/     # CI; every workflow is listed below
-Dockerfile, docker-compose.yml   # stale, do not build (see Docker)
+Dockerfile, docker-compose.yml   # API + Postgres, dataset mounted (see Docker)
 ```
 
 Routes under `/v1`: `health`, `version`, `brands`, `socs`, `smartphones`,
@@ -115,11 +115,19 @@ Smartphones continue to require numeric values for both fields.
 
 ### Docker
 
-`Dockerfile` and `docker-compose.yml` predate the split from TechAPI and do
-not work as they are: the Dockerfile copies `data/` and `scripts/`, which no
-longer exist here, so the image does not build, and the compose file mounts no
-TechAPI checkout for `app.seed` to read. No workflow builds or uses them. Use
-the Quickstart above; for Postgres, point `DATABASE_URL` at your own instance.
+The image holds the engine only and expects the dataset at `/data`
+(`TECHAPI_DATA_DIR`). `docker-compose.yml` starts Postgres and the API, and
+mounts `../TechAPI/data` read-only at that path, so clone the two repos side by
+side:
+
+```text
+<parent>/TechEngine   # this repo; run `docker compose up --build` here
+<parent>/TechAPI      # the dataset
+```
+
+The API seeds the database from the mount before it serves, which takes a
+while on the full dataset. The image has no git, so record timestamps are the
+seed time. No workflow builds or uses these files.
 
 ## Roadmap
 

Dockerfile

@@ -25,6 +25,12 @@ services:
       API_ENV: development
     ports:
       - "8000:8000"
+    # The dataset comes from a TechAPI checkout next to this repo:
+    #   <parent>/TechEngine   (this repo; run docker compose here)
+    #   <parent>/TechAPI      (git clone https://github.com/GetTechAPI/TechAPI.git)
+    # Its data/ is mounted read-only where the image's TECHAPI_DATA_DIR points.
+    volumes:
+      - ../TechAPI/data:/data:ro
     # Seed the database, then serve. Idempotent: re-running skips existing rows.
     command: >
       sh -c "python -m app.seed && uvicorn app.main:app --host 0.0.0.0 --port 8000"