mcpField
V
velt-setup-best-practices

velt-setup-best-practices

github.com/velt-jsDevelopment149 installsUpdated 4w ago
Repository

About velt-setup-best-practices

A reference skill for setting up the Velt collaboration SDK in React, Next.js, Angular, Vue, and HTML projects. It organizes 25 rules into nine areas, with examples and verification checklists in the individual rule files.

Key features

  1. 01Guidance across five project types
  2. 0225 setup rules in nine categories
  3. 03Installation and provider wiring guidance
  4. 04Identity and document setup guidance
  5. 05Examples and verification checklists

Use cases

  1. 01Adding Velt to a new project
  2. 02Configuring VeltProvider and API keys
  3. 03Setting up user identity and JWT generation
  4. 04Finding Velt rules for project organization

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/velt-js/agent-skills --skill velt-setup-best-practices

After installing, type/velt-setup-best-practicesin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

AGENTS.full.md
AGENTS.md
metadata.json
README.md
evals/
evals.json
rules/non-react/installation/
install-vanilla-packages.md
rules/non-react/provider-wiring/
provider-framework-init.md
rules/react/identity/
identity-auth-provider.md
rules/react/installation/
install-react-packages.md
rules/react/project-structure/
structure-folder-organization.md
structure-separation-of-concerns.md
rules/react/provider-wiring/
provider-client-directive.md
provider-velt-provider-setup.md
rules/react/routing-surfaces/
surface-collaboration-wrapper.md
surface-component-placement.md
rules/shared/
_sections.md
_template.md
rules/shared/components/
component-user-invite.md
rules/shared/config/
config-api-key.md
config-auth-token-security.md
config-domain-safelist.md
config-firestore-persistent-cache.md
config-proxy-config.md
rules/shared/debugging-testing/
debug-common-issues.md
debug-multi-user-testing.md
debug-setup-verification.md
rules/shared/document-identity/
document-id-generation.md
document-metadata.md
document-page-info.md
document-set-document.md

Details

From the project README

Velt Setup Best Practices

Comprehensive setup guide for Velt collaboration SDK. Contains 25 rules across 9 categories covering installation, authentication, document setup, and project organization.

When to Apply

Reference these guidelines when:

  • Setting up Velt in a new React, Next.js, Angular, Vue, or HTML project
  • Configuring VeltProvider and API keys
  • Implementing user authentication with Velt (userId, organizationId)
  • Setting up JWT token generation for production
  • Initializing documents with documentId
  • Organizing Velt-related files in your project

Rule Categories by Priority

PriorityCategoryImpactPrefix
1InstallationCRITICALinstall-
2Provider WiringCRITICALprovider-
3IdentityCRITICALidentity-
4Document IdentityCRITICALdocument-
5ConfigHIGHconfig-
6Project StructureMEDIUMstructure-
7Routing SurfacesMEDIUMsurface-
8ComponentsMEDIUMcomponent-
9Debugging & TestingLOW-MEDIUMdebug-

How to Use

Read individual rule files for detailed explanations and code examples:

rules/react/installation/install-react-packages.md
rules/react/provider-wiring/provider-velt-provider-setup.md
rules/shared/_sections.md

Each rule file contains:

  • Brief explanation of why it matters
  • Incorrect code example with explanation
  • Correct code example with explanation
  • Verification checklist
  • Source pointers to official docs

Compiled Documents

  • AGENTS.md — Compressed index of all rules with file paths (start here)
  • AGENTS.full.md — Full verbose guide with all rules expanded inline

Comments

Markdown supported