📂 Monorepo Structure for Stark Brawl

🚀 Key Features

✅ Modular Structure → Frontend, Backend, Smart Contracts & Docs stay separate but integrated. ✅ Monorepo Efficiency → Uses Turborepo / Nx to handle dependencies across projects. ✅ Shared Code → UI Components (packages/ui/), Utilities (packages/utils/), and SDK (packages/sdk/). ✅ Web3 Ready → Cairo Smart Contracts (apps/contracts/), with an SDK to interact from frontend/backend. ✅ CI/CD Ready → GitHub Actions (.github/workflows/) for automated testing, linting, and deployment. ✅ Documentation Hub → Supports GitBook or Docusaurus (apps/docs/).

Feel free to test it out and copy the Markdown below by hovering over the code block in the upper right, and pasting into a new line underneath.

stark-brawl-monorepo/
│── apps/                    # Main applications
│   ├── web/                 # React Frontend (Game UI)
│   ├── backend/             # Node.js Backend (Matchmaking, WebSockets)
│   ├── contracts/           # Starknet Smart Contracts (Cairo)
│   ├── docs/                # Documentation (GitBook/Docusaurus)
│
│── packages/                 # Shared Packages for Reusability
│   ├── ui/                   # Shared UI Components (React)
│   ├── utils/                # Common utilities (helpers, hooks)
│   ├── sdk/                  # Starknet SDK (interacting with contracts)
│
│── configs/                  # Configuration files
│   ├── eslint/               # Linting rules
│   ├── prettier/             # Code formatting rules
│   ├── tsconfig/             # TypeScript settings
│
│── scripts/                  # Automation & DevOps Scripts
│   ├── deploy.sh             # Deployment script
│   ├── setup.sh              # Environment setup
│
│── .github/                   # GitHub Actions (CI/CD)
│   ├── workflows/            # CI/CD pipelines
│
│── .gitignore                 # Ignore unnecessary files
│── package.json               # Root package.json (managing workspaces)
│── turbo.json                 # TurboRepo (for managing monorepo builds)
│── README.md                  # Project Overview

🛠️ How to Set Up & Run

1️⃣ Clone Repo & Install Dependencies

bashCopyEditgit clone https://github.com/SunsetLabs/StarkBrawl-Monorepo.git
cd stark-brawl-monorepo
pnpm install  # or yarn install

2️⃣ Run Apps in Parallel (TurboRepo)

bashCopyEditpnpm dev  # Runs frontend, backend & contracts together

3️⃣ Deploy Smart Contracts (Starknet)

bashCopyEditcd apps/contracts
starknet deploy --contract stark_brawl.cairo --network testnet

4️⃣ Start Backend (Matchmaking, API)

bashCopyEditcd apps/backend
pnpm start