Documentation
v1.0.0GitHub
Setup Guide
Installation
Add vibecoding to your project in multiple ways. Choose the method that works best for your setup.
Installation Methods
NPM Package (Coming Soon)
Install vibecoding as an npm package for the easiest integration
The NPM package is currently in development. For now, please use the copy & paste method below.
Terminal
npm install @vibecode/coreFramework Support
Next.js
Fully SupportedWorks out of the box with Next.js 13+ App Router
Setup GuideReact
SupportedCompatible with React 18+ applications
Setup GuideVite
CommunityCommunity-maintained integration guide
Setup GuideQuick Start
Your First Vibecode Editor
Get a basic editor running in your app
app/editor/page.tsx
"use client";
import { EnhancedEditor } from "@/components/editor/enhanced-editor";
export default function EditorPage() {
const handleBlocksChange = (blocks: Block[]) => {
console.log("Blocks updated:", blocks);
};
return (
<div className="min-h-screen bg-background">
<EnhancedEditor
onChange={handleBlocksChange}
/>
</div>
);
}Common Issues
Module not found errors
Make sure all peer dependencies are installed and your TypeScript paths are configured correctly.
View Troubleshooting GuideStyling issues
Ensure your Tailwind CSS configuration includes the necessary design tokens and the components are included in your content paths.
View Styling Guide