Operations & Tooling

Repositories & Branching

  • Origin: https://github.com/TechInvestorApp/TechInvestor.git

  • Default branch: main

  • Develop features on short-lived branches. Squash or rebase before merging to keep history clean.

Toolchain Requirements

Tool
Version
Notes

Node.js

18.x

Portable install accepted; ensure npm is on PATH (Windows).

npm

9.x

Used for installing and running scripts under web/.

Android Studio

Giraffe+

Build Jetpack Compose app.

Xcode

15+

Build SwiftUI app for iOS 17.

Git

Latest

Required for version control and Netlify deploys.

Local Setup

  1. Clone the repo and install dependencies in web/:

    cd web
    npm install
  2. Run the development server:

    npm run dev
  3. For Android, sync Gradle in Android Studio and build app.

  4. For iOS, open TechInvestorMobile.xcodeproj and build TechInvestorMobile.

Quality Gates

  • npm run lint (web) – must pass before committing.

  • Android build – ./gradlew assembleDebug should succeed.

  • iOS build – Xcode project should compile without warnings.

  • Manual parity check – verify copy changes across web/Android/iOS before final review.

Deployment

  • Hosting: Netlify (configured via netlify.toml).

    • base = web

    • command = npm run build

    • publish = .next

    • Uses @netlify/plugin-nextjs for ISR/serverless support.

  • Ensure web/ remains self-contained so Netlify caching stays effective.

Environment Variables

  • None required today. When adding secrets (e.g., database URLs or Persona API keys), document them here and update Netlify/CI configs.

Observability & Logging

  • Currently minimal; rely on Netlify logs and Next.js server console output.

  • Plan to integrate structured logging plus alerting when persistent storage lands.

Incident Response Placeholder

  • Define on-call rota and escalation once live data is processed.

  • Draft runbooks for submission ingestion failures, dashboard latency, and privacy incidents.

Change Management

  • Update /docs and .github/copilot-instructions.md whenever workflows shift.

  • Flag analyst stakeholders when KYC provider settings or badge rules change.

  • Keep JIRA/issue tracker (if adopted) linked to PRs for traceability.

  • Use PR templates to record testing performed (lint/build + mobile verification).

Last updated

Was this helpful?