project-template.md 1.7 KB

New Project Setup

Use this template to scaffold a new project folder. Copy it to ~/Github/ProjectName.

~/Github/ProjectName/
├── README.md                 # Project overview, how to run it locally
├── docs/
│   ├── ARCHITECTURE.md       # System design, key modules, data flow
│   ├── SETUP.md              # Dev environment setup, dependencies
│   └── API.md                # (if applicable) API docs, endpoints
├── src/                      # Source code (adjust per tech stack)
│   ├── index.js
│   └── ...
├── tests/                    # Tests (unit, integration, e2e)
│   ├── unit/
│   ├── integration/
│   └── ...
├── package.json              # (or requirements.txt, Cargo.toml, etc.)
├── .gitignore
├── .github/
│   └── workflows/            # (optional) CI/CD
└── .git/                      # Initialized git repo

Minimal first commit

Before the first ticket starts, initialize the repo with:

  1. A basic README explaining what the project is
  2. Project setup instructions (how to npm install, python -m venv, etc.)
  3. A way to run tests (npm test, pytest, etc.)
  4. A main (or develop) branch

The Developer agent will inspect this structure to know how to build. Make sure tests pass on a clean checkout before the first ticket — that's the baseline.

Then: Add to Notion

Add a row to the Projects database:

  • Repo = ~/Github/ProjectName
  • Default Branch = main
  • Tech Stack = "Node.js 18, React, Jest" (whatever applies)
  • Description = one-line summary
  • Status = Active

Now you can drop tickets into its Backlog and they'll flow through the agents.