# 🌌 Vibe Coding Kit — Edward Yin Academy Edition

> **Build software like a pro, even if you've never coded in your life.**

<div align="center">
  <img src="https://img.shields.io/badge/Skill%20Level-Absolute%20Beginner-green?style=for-the-badge" alt="Beginner Friendly" />
  <img src="https://img.shields.io/badge/Vibecoding-100%25%20Ready-orange?style=for-the-badge" alt="Vibecoding" />
  <img src="https://img.shields.io/badge/Academy-Official-red?style=for-the-badge" alt="Academy" />
</div>

---

### 🚀 What is this?
Welcome to the **Edward Yin Academy** Vibe Coding Kit. 

Imagine having an elite team of software engineers, world-class designers, and cybersecurity experts living inside your computer. This kit "hires" them for you. You don't need to learn how to code; you just need to learn how to **talk** to them. This is called **Vibecoding**.

---

## 💻 Step 0: The Command Center (The Terminal)

To set everything up, we need to use your computer's **Terminal** (also called the Command Center). This is a window where you type direct instructions to your computer.

### How to open it:
*   **🪟 Windows**: Click your Start button, type `PowerShell`, and press Enter.
*   **🍎 Mac**: Hold the `Command` key and tap the `Spacebar`. Type `Terminal` and press Enter.

> [!TIP]
> **How to Paste**: If you copy a command from this guide, you can usually paste it into the terminal by **Right-Clicking** anywhere in the window or pressing `Ctrl + V` (Windows) or `Command + V` (Mac).

---

## 🛠️ Step 1: The Foundation (NVM & Node)

First, we need to install the engine that runs our AI tools.

### 🪟 If you use Windows:
1. Download the installer from [this link](https://github.com/coreybutler/nvm-windows). 
2. Open the file and keep clicking **Next** until it is finished.
3. Open your **Terminal** (PowerShell) and type these two lines (one at a time):
   ```bash
   nvm install latest
   nvm use latest
   ```

### 🍎 If you use Mac:
1. Copy and paste this line into your **Terminal** and press Enter:
   ```bash
   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
   ```
2. Close your Terminal window and open a new one.
3. Type these two lines (one at a time):
   ```bash
   nvm install node
   nvm use node
   ```

---

## 📦 Step 2: Choose Your Setup Method

There are two primary ways to run the Vibe Coding Kit depending on whether you want to configure a specific project or set up your global developer environment.

### Option A: Local Project Initialization (Per-Project)
Perfect for configuring a single workspace. This creates a `.agent/` folder containing the workflows and skills in your current project directory.

*   **Via NPX (Zero Install)**:
    ```bash
    npx @edwardyinacademy/vibe-coding-kit init
    ```
*   **Via Global Package**:
    If you have installed the package globally, simply run:
    ```bash
    vibe-coding init
    ```

---

### Option B: Global Environment Initialization (Recommended 🚀)
Apply the Vibe Coding templates and skills globally. This configures the kit directly in your global agent environments, enabling these capabilities automatically for **all** projects running under them.

1. **Install the CLI globally**:
   ```bash
   npm install -g @edwardyinacademy/vibe-coding-kit
   ```
   *(This registers both the `vibe-coding` and `vibe-coding-kit` commands globally)*

2. **Initialize globally for all platforms (Claude Code, Gemini/Antigravity 2.0, & Antigravity-IDE)**:
   ```bash
   vibe-coding init --global
   ```

3. **Or initialize for a specific platform**:
   *   **Claude Code** (`~/.claude/`):
       ```bash
       vibe-coding init -g -p claude
       ```
   *   **Gemini / Antigravity 2.0** (`~/.gemini/antigravity/`):
       ```bash
       vibe-coding init -g -p gemini
       # or
       vibe-coding init -g -p antigravity-2.0
       ```
   *   **Antigravity-IDE** (`~/.gemini/antigravity-ide/`):
       ```bash
       vibe-coding init -g -p antigravity-ide
       ```

> [!NOTE]
> **Smart MCP Server Merging**: When running the global initialization, the CLI automatically detects and merges our model context protocol (MCP) servers with your existing `mcp_config.json`. Your custom servers will be preserved.

---

## 🧹 Step 3: Cleanup & Removal

If you ever need to remove the templates or clean up your environment:

*   **Remove local project templates**:
    ```bash
    vibe-coding remove
    ```
*   **Remove global templates from all platforms**:
    ```bash
    vibe-coding remove --global
    ```
*   **Remove global templates from a specific platform**:
    *   **Claude Code**:
        ```bash
        vibe-coding remove -g -p claude
        ```
    *   **Gemini / Antigravity 2.0**:
        ```bash
        vibe-coding remove -g -p gemini
        ```
    *   **Antigravity-IDE**:
        ```bash
        vibe-coding remove -g -p antigravity-ide
        ```

---

## 🔄 Step 4: Keeping Your Kit Updated

The Vibe Coding Kit is constantly evolving. To get the latest skills, updates, and templates:

### 1. Update the Global CLI Tool
```bash
npm update -g @edwardyinacademy/vibe-coding-kit
```

### 2. Update Your Project / Global Environments
Simply run the global or local `init` command again with your desired options to overwrite the base files with the latest updates while preserving custom changes where supported.

---

## 🛠️ For Developers (Local Setup)
If you are contributing to this repository or testing local changes:
1. Open your terminal in this folder.
2. Run `npm link`.
3. You can now use `vibe-coding` (for production) and `vibe-coding sync` (to pull latest upstreams) anywhere.

Your AI expert team is now officially "on the clock" and ready to build with you.

---

## 🎨 How to "Vibe" With Your AI

Open your project in your favorite **Agentic Environment** (IDE or Terminal). Once you are inside, you can use **Magic Shortcuts** to get things done fast:

| Shortcut | What it does | When to use it |
| :--- | :--- | :--- |
| **/brainstorm** | **Bounce Ideas** | Use this to explore ideas and get suggestions before building. |
| **/plan** | **Ask for a Map** | Use this when you have an idea but need a step-by-step roadmap. |
| **/create** | **Build it Now** | Use this when you want the AI to build a new feature or app for you. |
| **/enhance** | **Level Up** | Use this to improve or add more features to what you've already built. |
| **/namecard** | **Digital ID** | Use this to build a premium digital namecard with lead capture logic. |
| **/debug** | **Fix the Problem** | Use this when something isn't working and you need the AI to fix it. |
| **/ui-ux-pro-max** | **Make it Pretty** | Use this to give your app a high-end, professional look. |
| **/orchestrate** | **Team Effort** | Use this for big tasks where you need multiple AI experts working together. |
| **/preview** | **See Your Work** | Use this to open a live view of your app and see your changes instantly. |
| **/test** | **Double Check** | use this to make sure everything works perfectly and there are no mistakes. |
| **/deploy** | **Go Live** | Use this when you are ready to launch your app to the world. |
| **/status** | **Progress Check** | Use this to get a quick summary of what's finished and what's next. |

---

## 📚 Vibe Coding Awesome Skills Library

We have integrated over **1,400+ specialized skills** from the global Awesome Skills library. These skills cover everything from advanced DevOps and Security to niche Frameworks and Data Science.

To use them, simply refer to them in your chat:
*   *"Use @vibe-coding-workflows to ship this MVP"*
*   *"Apply @react-best-practices to this component"*
*   *"Run a security audit using @vulnerability-scanner"*

You can find the full list of skills in the `.agent/skills/` folder of your project.

---

## 📄 License

MIT © Edward Yin Academy
