---

name: project-scaffolding description: Initialize new projects with proper structure, configuration, and setup from BaseProject template. Use when creating new projects, setting up directory structures, or initializing repositories.

Project Scaffolding Skill

When to Activate

Activate this skill when:

• Creating new projects from scratch
• Setting up project directory structure
• Initializing configuration files
• Starting from BaseProject template
• Setting up technology-specific projects

Quick Setup Methods

Directory Naming Conventions

CopyDirectories:     CamelCase (VideoProcessor, AudioTools)
Date-based:      kebab-case with YYYY-MM-DD (logs-2025-01-15)
NO spaces or underscores in directory names

Manual Setup Workflow

Step 1: Copy Template

Copycp -r /path/to/BaseProject ~/Projects/YourProjectName/
cd ~/Projects/YourProjectName/

Step 2: Clean Git History

Copyrm -rf .git

Step 3: Customize AGENT.md

Fill in project-specific sections:

Copy## Project Purpose
A REST API for managing inventory with real-time updates.

## Tech Stack
- Language: Python 3.11+
- Framework: FastAPI
- Key Libraries: SQLAlchemy, Pydantic
- Package Manager: UV

## Architecture Notes
- Microservices with event-driven updates
- Redis for caching
- PostgreSQL for persistence

Step 4: Initialize Git

Copygit init
git add .
git commit -m "chore: initialize repository from BaseProject"

Technology-Specific Setup

Python with UV

Copyuv init
cp AgentUsage/templates/pyproject.toml.example pyproject.toml
uv add fastapi uvicorn sqlalchemy
uv add --dev pytest black ruff mypy

mkdir -p src/YourProject/{core,utils,config}
mkdir -p tests/{unit,integration}
touch src/YourProject/__init__.py

JavaScript/TypeScript

Copypnpm init
pnpm add express dotenv
pnpm add -D typescript @types/node jest eslint prettier

mkdir -p src/{routes,controllers,middleware,utils}
touch src/index.ts

Go

Copygo mod init github.com/user/project
mkdir -p cmd/api internal/{handlers,models,database} pkg
touch cmd/api/main.go

Rust

Copycargo init
mkdir -p src/{routes,models,db}
cargo build

Standard Project Structure

Python

Copyproject/
├── src/
│   └── projectname/
│       ├── __init__.py
│       ├── main.py
│       ├── core/
│       ├── utils/
│       └── config/
├── tests/
│   ├── conftest.py
│   ├── unit/
│   └── integration/
├── pyproject.toml
├── uv.lock
├── AGENT.md
└── .gitignore

JavaScript

Copyproject/
├── src/
│   ├── index.ts
│   ├── routes/
│   ├── controllers/
│   └── utils/
├── tests/
├── package.json
├── tsconfig.json
├── AGENT.md
└── .gitignore

Secrets Setup

Copy# Create template
cp AgentUsage/templates/secrets_template.json secrets_template.json

# Create actual secrets (gitignored)
cp secrets_template.json secrets.json

# Verify in .gitignore
grep "secrets.json" .gitignore

Task Tracking

Track tasks in GitHub Issues with appropriate labels. Create initial issues for:

• Set up project dependencies
• Configure secrets management
• Create initial project structure
• Implement core business logic
• Add unit tests
• Set up CI/CD pipeline

Verification Checklist

Copy# Git initialized and clean
git status

# AGENT.md customized (no [Fill in:] markers)
grep "\[Fill in:" AGENT.md

# secrets.json in .gitignore
grep "secrets.json" .gitignore

# Dependencies installed
uv sync  # or pnpm install

# Project runs
uv run python src/projectname/main.py

Post-Setup Tasks

1. Create GitHub Issues for project-specific tasks
2. Create initial code entry points
3. Configure IDE settings and extensions
4. Review relevant guides in AgentUsage/

Common Issues

Permission denied on scripts

Copychmod +x setup_new_project.sh

Git commit fails

Copygit config user.name "Your Name"
git config user.email "your.email@example.com"

Dependencies not installing

Copy# Python: Clear cache
uv cache clean

# JavaScript: Fresh install
rm -rf node_modules pnpm-lock.yaml
pnpm install

Related Resources

See AgentUsage/project_setup.md and AgentUsage/project_structure.md for:

• Detailed directory patterns
• CI/CD setup
• Pre-commit hook installation
• Technology-specific guides