Skip to main content

Tier 1: Quick Start

Open Repo Download ZIP

git clone https://github.com/AEEF-AI/aeef-quickstart.git my-project

Goal: Safe AI-assisted development in 30 minutes.

The Quick Start tier provides a template repository with everything a developer or small team needs to begin AI-assisted development under AEEF governance. It enforces the five foundational production standards through pre-configured tooling, so teams get immediate guardrails without building infrastructure from scratch.

If you need an execution-first checklist, use Apply Path (Tier 1 Quick Start).

What's Included​

  • AI tool configuration -- .cursorrules, .github/copilot-instructions.md, .claude/settings.json, and .windsurfrules that enforce prompt discipline and AI-disclosure practices (PRD-STD-001)
  • Pull request template -- .github/PULL_REQUEST_TEMPLATE.md with AI-disclosure checklist and review requirements (PRD-STD-002)
  • Test configuration -- Language-specific test runner configs with minimum 80% coverage threshold (PRD-STD-003)
  • Security scanning -- Semgrep rules and dependency audit commands in CI (PRD-STD-004)
  • Dependency management -- Lockfile enforcement and pinned dependency versions (PRD-STD-008)
  • CI pipeline -- GitHub Actions workflow that runs lint, test, and security checks on every PR
  • Git workflow -- Branch protection rules, conventional commit configuration, and .gitignore

Prerequisites​

  • Git 2.30+
  • One of the following language runtimes:
    • TypeScript: Node.js 22+ and npm
    • Python: Python 3.12+ and uv
    • Go: Go 1.22+
  • An AI coding tool (Cursor, GitHub Copilot, Claude Code, Windsurf, or similar)

Quick Start Steps​

1. Create Your Repository​

Use the template or clone directly:

# Option A: Use as GitHub template (recommended)
# Click "Use this template" on https://github.com/AEEF-AI/aeef-quickstart

# Option B: Clone directly
git clone https://github.com/AEEF-AI/aeef-quickstart.git my-project
cd my-project
rm -rf .git && git init

2. Choose Your Language Stack​

Each language lives in its own directory with a complete, runnable example application:

quickstart/
  typescript/    # Next.js starter with Jest, ESLint, Semgrep
  python/        # FastAPI starter with pytest, Ruff, Semgrep
  go/            # Chi starter with go test, golangci-lint, Semgrep

Copy your chosen stack to the repo root or work within the language directory.

3. Run the Setup Script​

./scripts/setup.sh --lang typescript   # or python, go

The setup script installs dependencies, verifies tool versions, and runs an initial lint + test pass to confirm everything works.

4. Install Dependencies​

# TypeScript
npm install

# Python
uv sync

# Go
go mod download

5. Run Tests​

# TypeScript
npm test

# Python
uv run pytest

# Go
go test ./...

6. Make Your First AI-Assisted PR​

  1. Create a feature branch: git checkout -b feat/my-first-ai-feature
  2. Use your AI tool to generate or modify code
  3. Run the full check suite: npm run check (or equivalent)
  4. Commit with a conventional commit message: feat: add user validation endpoint
  5. Push and open a PR -- the CI pipeline and PR template will enforce AEEF standards automatically

Standards Enforced​

StandardHow It's EnforcedKey Files
PRD-STD-001AI tool configs with AEEF rules.cursorrules, .github/copilot-instructions.md
PRD-STD-002PR template with AI-disclosure checklist.github/PULL_REQUEST_TEMPLATE.md
PRD-STD-003Test runner with 80% coverage gatejest.config.ts / pytest.ini / test configs
PRD-STD-004Semgrep + dependency audit in CI.semgrep/, CI workflow
PRD-STD-008Lockfile enforcement, pinned versionspackage-lock.json / uv.lock / go.sum

Language-Specific Guides​

  • TypeScript -- Node.js 22+, Next.js, Jest, ESLint flat config
  • Python -- Python 3.12+, FastAPI, pytest, Ruff
  • Go -- Go 1.22+, Chi, go test, golangci-lint

Already Have a Project?​

If you are adding AEEF standards to an existing codebase rather than starting fresh, use the Standalone Config Packs instead. They provide the same configurations as drop-in files without requiring you to adopt the template repo structure.

Repository​

github.com/AEEF-AI/aeef-quickstart

Last updated on by BalrogEg