86 lines
2.9 KiB
Markdown
86 lines
2.9 KiB
Markdown
---
|
|
name: ck-bootstrap
|
|
description: >
|
|
Project scaffolding wizard that sets up new projects with best-practice structure.
|
|
Activate when user says '/bootstrap', 'scaffold a new project', or 'set up project structure'.
|
|
Accepts project type, tech stack, and configuration preferences.
|
|
---
|
|
|
|
## Overview
|
|
Interactive wizard that scaffolds new projects with opinionated directory structures,
|
|
configuration files, dependencies, and documentation templates based on project type.
|
|
|
|
## When to Use
|
|
- Starting a new project from scratch
|
|
- Setting up a new service or microservice within an existing system
|
|
- Need to establish consistent project structure across a team
|
|
- Migrating legacy code into a standardized structure
|
|
|
|
## Don't Use When
|
|
- Project already has an established structure — modify existing instead
|
|
- Only adding a single feature to an existing project
|
|
- User wants a minimal skeleton without opinions
|
|
|
|
## Steps / Instructions
|
|
|
|
### Phase 1: Discovery (Ask First)
|
|
Collect via targeted questions:
|
|
1. **Project type**: web app / API / CLI / library / mobile
|
|
2. **Primary language/framework**: Node.js, Python, Go, React, etc.
|
|
3. **Database**: PostgreSQL, MongoDB, SQLite, none
|
|
4. **Authentication**: needed / not needed
|
|
5. **Testing framework**: preference or use default for stack
|
|
6. **Deployment target**: Docker, serverless, bare metal, cloud provider
|
|
|
|
### Phase 2: Structure Generation
|
|
Based on answers, generate:
|
|
|
|
```
|
|
project-name/
|
|
├── src/
|
|
│ ├── core/ # Business logic
|
|
│ ├── api/ # Route handlers / controllers
|
|
│ ├── services/ # External integrations
|
|
│ └── utils/ # Shared utilities
|
|
├── tests/
|
|
│ ├── unit/
|
|
│ └── integration/
|
|
├── docs/
|
|
│ ├── codebase-summary.md
|
|
│ ├── system-architecture.md
|
|
│ └── code-standards.md
|
|
├── .github/
|
|
│ └── workflows/
|
|
├── docker-compose.yml (if Docker selected)
|
|
├── .env.example
|
|
├── README.md
|
|
└── CLAUDE.md
|
|
```
|
|
|
|
### Phase 3: Configuration Files
|
|
Create based on stack:
|
|
- Package manifest (package.json, pyproject.toml, go.mod)
|
|
- Linting config (.eslintrc, .pylintrc, golangci.yml)
|
|
- Formatter config (.prettierrc, black config)
|
|
- Git hooks (pre-commit, pre-push)
|
|
- CI/CD workflow templates
|
|
- Docker/compose files if applicable
|
|
|
|
### Phase 4: Documentation Templates
|
|
Pre-populate:
|
|
- `README.md` with project name, stack, setup instructions
|
|
- `docs/codebase-summary.md` with architecture overview
|
|
- `docs/code-standards.md` with team conventions
|
|
- `CLAUDE.md` with project-specific AI guidance
|
|
|
|
### Phase 5: Confirmation
|
|
Show summary of what will be created. Ask user to confirm before writing files.
|
|
After confirmation, create all files and directories.
|
|
|
|
### Output Summary
|
|
Report created files grouped by category:
|
|
- Directories created
|
|
- Config files written
|
|
- Documentation scaffolded
|
|
- Next steps for the user (install deps, configure env, etc.)
|