Skip to content

README.md

Latest commit

 

History

History
81 lines (61 loc) · 4.2 KB

README.md

File metadata and controls

81 lines (61 loc) · 4.2 KB

CometChat — Cursor Marketplace plugin

CometChat

Add real-time chat — messaging, calls, AI agents — to any React, Next.js, React Router, Astro, Expo, or bare React Native project via the Cursor agent.

This repo is the source for the CometChat plugin on the Cursor Marketplace. Cursor users install the plugin, ask the agent add chat to my app, and watch a working chat integration get written into their project.

Install (Cursor users)

In Cursor:

  1. Open Marketplace → search CometChat → install.
  2. In the Cursor agent, ask: 
    add chat to my app
  3. Answer 4–5 setup questions (account, app name, region, intent, placement).
  4. The agent writes the integration into your project.

See plugins/cometchat/README.md for the full install + usage docs that the marketplace listing surfaces.

What's in this repo

.cursor-plugin/
└── marketplace.json              Cursor Marketplace entry — owner, plugin list

plugins/
└── cometchat/
    ├── .cursor-plugin/plugin.json    Plugin manifest (name, version, license, keywords)
    ├── README.md                     User-facing install + usage docs
    ├── assets/logo.png               148×148 CometChat logo
    └── skills/                       13 pre-bundled skills
        ├── cometchat/                Dispatcher — detects framework, writes code
        ├── cometchat-core/           Init / login / provider / env vars
        ├── cometchat-components/     60+ component catalog
        ├── cometchat-placement/      Where to put chat (route, modal, drawer, widget)
        ├── cometchat-react-patterns/         Vite + CRA patterns
        ├── cometchat-nextjs-patterns/        App Router + Pages Router
        ├── cometchat-react-router-patterns/  v6 + v7
        ├── cometchat-astro-patterns/         React islands
        ├── cometchat-theming/        Theme presets + brand colors
        ├── cometchat-features/       40+ features (calls, polls, AI, etc.)
        ├── cometchat-customization/  Custom views, formatters, builders
        ├── cometchat-production/     Server-minted auth, user management
        └── cometchat-troubleshooting/ Diagnostics, drift, doctor

scripts/
└── validate-template.mjs        Cursor's submission validator (passes)

docs/
└── add-a-plugin.md              Multi-plugin layout reference (from cursor/plugin-template)

How this stays current

The plugins/cometchat/skills/ directory is a snapshot from the canonical source-of-truth: github.com/cometchat/cometchat-skills. When skills change there, this repo is re-bundled and republished.

For Cursor reviewers

  • Submission checklist:
    • .cursor-plugin/marketplace.json has unique kebab-case name (cometchat)
    • plugins/cometchat/.cursor-plugin/plugin.json valid (kebab-case name, displayName, author, description, keywords, MIT license, version 3.1.0)
    • marketplace.json → plugins[].source resolves to ./plugins/cometchat/
    • Logo committed at plugins/cometchat/assets/logo.png, referenced via relative path in plugin.json
    • node scripts/validate-template.mjs passes (only optional warnings about hooks/mcp.json which we don't ship)
    • All SKILL.md files have valid frontmatter (verified by the canonical repo's harness — 156 tests passing)

License

MIT. See LICENSE once added by the canonical skills repo's release flow, or refer to the per-skill MIT declarations in each SKILL.md frontmatter.

Source + related