Skip to content

perashanid/readme-builder-studio

Repository files navigation

README Builder Studio

A visual drag-and-drop README generator with live preview, customizable templates, and markdown export functionality for creating professional project documentation.

Features

  • Component-based README builder with drag-and-drop interface
  • Live markdown preview with syntax highlighting
  • Pre-built templates for common project types
  • Customizable component library (badges, installation, usage, features, etc.)
  • Component configuration panel with real-time updates
  • Reorderable sections with visual feedback
  • Markdown export and download functionality
  • Mobile-responsive design with touch support
  • Dark mode support
  • Search functionality for components

Tech Stack

  • React 18
  • TypeScript
  • Vite
  • Tailwind CSS
  • Supabase for backend
  • Radix UI components
  • React Router
  • React Query
  • React Hook Form with Zod validation
  • Fuse.js for fuzzy search
  • Lucide React icons

Installation

npm install

Development

npm run dev

Build

npm run build

Preview

npm run preview

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages