Skip to content

BROS Technology — Developer Documentation

Welcome to the technical documentation for the BROS Technology marketplace platform.

  • Getting Started

    Clone, install, and run the project locally. Environment variables, prerequisites, and setup steps.

    Getting Started

  • :material-architecture-outline:{ .lg .middle } Architecture

    Folder structure, data flow, database schema, authentication, and deployment architecture.

    Architecture

  • Features

    Every screen and page across all four codebases. What it does, which files implement it.

    Features

  • API Reference

    Every backend endpoint with request/response shapes, error formats, and authentication.

    API Reference

  • Deployment

    How to deploy each part to production, migrations, rollback procedures.

    Deployment

  • Brand & Design

    Color palette, typography, spacing, brand assets, component patterns.

    Brand & Design

Document Audience Description
Overview Everyone What the system does, system diagram, tech stack
Getting Started Developers Prerequisites, setup, environment variables
Architecture Developers Folder structure, data flow, database schema
Features Everyone Every screen and page
API Reference Developers All endpoints
Deployment Developers Deploy, migrate, rollback
Brand & Design Design/Devs Colors, typography, assets
Known Issues Everyone Bugs, tech debt, out-of-scope
For Developers Developers Where to start, conventions, gotchas

Deployed Surfaces

Surface URL
Backend API https://bros-technology-api.vercel.app
Public Website https://bros-technology.vercel.app
Admin Web Portal https://bros-technology-admin.vercel.app
Admin Mobile App com.brostechnology.admin (APK / iOS)
Developer Docs https://docs.brostechnology.com