Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 3.25 KB

README.md

File metadata and controls

56 lines (40 loc) · 3.25 KB

Zigex docs

Only living documents are kept here. Old change reports and Supabase-era guides were removed on 7 October 2026; git log --diff-filter=D -- docs/ lists them if you need one back.

Start here

Doc What it's for
architecture.md How the system fits together: parts, request flow, sign-in, caching, uploads, notifications, environments, security.
developer-guide.md Working on the app: setup, folder map, conventions, recipes, git workflow, releasing, debugging.

Backend (send these to the backend team)

Doc What it's for
backend/open-requests.md Every endpoint the student app uses and its status, plus everything still open (bugs, uploads, response shapes). Start here.
backend/notifications.md How notifications should work: events, wording, links, the record format, /push/trigger security, push delivery.

The API itself is documented in Swagger: https://api.zigexconnect.com/api-docs (JSON at /api-docs.json).

Product

Doc Status
product/community-guidelines-draft.md Draft. Items marked [DECIDE] need a decision before publishing.
product/attendance-geolocation-qr.md How geolocation and QR attendance work (short version).
product/attendance-geolocation-qr-deepdive.md The full technical write-up (also as a PDF).
product/intern-ledger.md Intern payments ledger: design and roadmap. Written before the backend move; data now lives behind the API.
product/admin-side-handoff.md Next phase. What the admin app must provide for the student side (placements, QR posters, tasks, report review, updates, fees) and the design system to reuse.

Legal

Doc What it's for
legal/terms-and-policies.md Terms of Use and Privacy Policy in one file (same text as /terms and /privacy), for review and records.

Setup

Doc What it's for
setup/server.md Our VPS as it is set up: user, Node through nvm, folders, ports, GitHub settings, what is left, and how to release 1.1.0 and switch zigexconnect.com.
setup/deployment-guide.md Step-by-step: put both sites online on a new VPS (DNS, server, Nginx/HTTPS, GitHub, first deploys, hand-over).
setup/deploy.md CI, releasing a version, deploying to the VPS, rollback, one-time VPS setup.
setup/email.md Gmail and EmailJS: environment variables, templates and their fields.

Content

Doc What it's for
content/blog-bamenda-startups.md Blog article draft: top tech startups in Bamenda.

Keeping this folder tidy

  • One topic per doc; update it in place instead of writing a new "fixes" or "summary" file.
  • When a request to the backend is done, remove it from open-requests.md.
  • Don't add docs that repeat what the code or git history already says.