Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .cursor/rules/workflow.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ alwaysApply: true
---

## Template Setup Workflow
- **Agent-Driven Initialization**: When a user prompts "initialize the repo" or similar, I will automatically handle template setup:
- **Agent-Driven Initialization**: When a user prompts "set up the template" or "initialize the repo" (for cloned templates), I will automatically handle template setup:
1. **Copy `.cursor/.mcp.json.example` to `.cursor/mcp.json`** and prompt user for their API keys
2. **Optionally copy `.env.example` to `.env`** only if they plan to use TaskMaster CLI (not needed for MCP workflow)
3. **Remove template-specific content** and customize for their project:
- Replace `README.md` with their project-specific README
- **Move `README.md` to `docs/how_to_use_this_template.md`** to preserve template documentation
- **Create new project-specific `README.md`** using the template from `.cursor/templates/project_readme.md`
- Replace `[Project Name]` placeholder with user-provided name or "My Project"
- Update `SECURITY.md` to remove template references
- Remove or update any hardcoded paths in configuration files
- **Environment File Distinction**:
Expand Down Expand Up @@ -46,7 +48,9 @@ alwaysApply: true
## Git Workflow

### Repository Initialization
When you request to "initialize git repo", I will perform the following steps:
**Note**: This is only needed when cloning the template directly. When using this as a GitHub template (recommended), a fresh repository is automatically created.

When you request to "initialize git repo" (only needed for cloned templates), I will perform the following steps:
1. **Clear template git history**: Remove the existing `.git` directory to start fresh (`rm -rf .git`).
2. Initialize a local Git repository (`git init`).
3. Create a `.gitignore` file with at least the following entries:
Expand Down
25 changes: 25 additions & 0 deletions .cursor/templates/project_readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# [Project Name]

> Brief description of what this project does

## 🚀 Getting Started

### Prerequisites
- List any dependencies or requirements

### Installation
```bash
# Add installation commands
```

## 📖 Usage

Describe how to use your project

## 🤝 Contributing

Guidelines for contributing to this project

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,34 @@ A comprehensive project template for **vibe coding** in Cursor with pre-configur

## 🚀 Quick Start

### 1. Template Setup (After Cloning)

**Agent-Driven Setup (Recommended)**
### 1. Create Your Project

**Recommended: Use as GitHub Template**
1. Click "Use this template" button on GitHub
2. Create your new repository from the template
3. Clone your new repository:
```bash
git clone git@github.com:yourusername/your-project-name.git
cd your-project-name
cursor .
```
4. Prompt the AI agent: `"Set up the template for my new project"`

**Alternative: Clone Template Directly**
```bash
# After cloning the template to your project folder
# If you cloned the template repository directly
git clone git@github.com:your-org/project_template.git my-new-project
cd my-new-project

# Open in Cursor
cursor .

# Then prompt the AI agent:
# "Initialize the repo for my new project"
```

The AI agent will automatically handle all template setup including:
The AI agent will automatically handle template setup including:
- Setting up your MCP configuration
- Customizing files for your project
- Initializing git repository and GitHub repo
- Initializing git repository and GitHub repo (only needed for cloned templates)

**Manual Setup (If Preferred)**
```bash
Expand All @@ -57,7 +67,8 @@ cp .env.example .env # Optional
### 2. Start Vibe Coding
```bash
cursor .
# Then prompt: "Initialize the repo for my new project"
# For GitHub template usage: "Set up the template for my new project"
# For cloned templates: "Initialize the repo for my new project"
```

## ✨ Features
Expand Down Expand Up @@ -115,9 +126,11 @@ project_template/
This template is optimized for **vibe coding** - a development style that balances structure with creative flow using controlled MCP workflows.

### 🚀 Initialize Git Repository
**Note:** Only needed when cloning the template directly. When using as a GitHub template (recommended), your repository is already initialized.

**Prompt:** `"Initialize git repo"` or `"Initialize the repo for my new project"`

The AI agent automatically follows this workflow:
For cloned templates, the AI agent automatically follows this workflow:
1. **Template Cleanup** - Removes template-specific `.git` history
2. **Local Git Setup** - Initializes fresh repository with proper `.gitignore`
3. **GitHub Repository** - Creates private repo with issues enabled via GitHub CLI
Expand Down