Skip to content

FindingNearBy Documentation

Welcome to the operational & developer reference for the FindingNearBy platform — a federation of societies covering events, vendors, coaching, digital signage and resident services across mobile and web.

This site is the source of truth for Methods of Procedure (MOPs) that both the operations team and engineers use to onboard, govern and audit the platform.

Reading guide

Every MOP is structured the same way:

Section What you'll find
Purpose What this procedure achieves and when it's triggered
Pre-requisites Roles, data and prior MOPs you need first
Step-by-step Click-by-click flow for both Admin Dashboard and Mobile
Snapshot Live screenshot taken from the running product
APIs touched Exact REST endpoints with HTTP method
Data model MongoDB collections & key fields
Edge cases & FAQ Real-world gotchas and operator answers
Related MOPs Cross-links to keep context

Stack overview

   ┌─────────────────────┐     ┌─────────────────────┐
   │  Mobile (RN/Expo)   │     │  Admin Dashboard    │
   │  resident, vendor,  │     │  super_admin /      │
   │  coach, guest       │     │  society_admin      │
   └──────────┬──────────┘     └──────────┬──────────┘
              │  HTTPS                    │  HTTPS
              ▼                           ▼
   ┌────────────────────────────────────────────────┐
   │   FastAPI Backend  (api.findingnearby.com)     │
   │   /app/backend/server.py  •  MongoDB  •  MinIO │
   └────────────────────────────────────────────────┘
  • 🔐 Role Matrix
  • 📜 MOP Template — copy this to add a new MOP
  • 🖥️ Admin Dashboard: admin.findingnearby.com
  • 🔌 API: api.findingnearby.com
  • 📱 Mobile App: Play / App Store

Contributing

Edit any .md file under /app/docs/, then run sudo bash /app/deploy/scripts/deploy_docs.sh to publish. The full publishing guide lives in deploy/README.md.