A fast, accessible README builder — edit blocks, drag to reorder, export clean Markdown.

Features · Quick start · Usage · Tech stack · Project structure · Contributing · License

---

Features

• 🧱 Block-based editor — every section of your README is a block you can edit, duplicate, or delete.
• 🖱️ Drag to reorder — rearrange your document in seconds, no cut-and-paste required.
• 📤 Clean Markdown export — get portable, lint-friendly Markdown with no vendor lock-in.
• 🎨 Themeable — ship a README that looks right in both light and dark mode.
• ⚡ Fast — instant previews powered by Vite and TanStack Query.
• ♿ Accessible — keyboard navigable, semantic markup, screen-reader friendly.

Quick start

Prerequisites

• Bun >= 1.0 (or Node.js >= 20 with npm / pnpm)
• A Supabase project for auth and persistence

Installation

git clone https://github.com/pratyay360/drawy.git
cd drawy
bun install

Environment

Create a .env.local file in the project root:

VITE_SUPABASE_URL=your-supabase-project-url
VITE_SUPABASE_ANON_KEY=your-supabase-anon-key

Run locally

bun run dev

The app will be available at http://localhost:5173.

Usage

1. Pick a block from the palette — headers, badges, lists, tables, code samples, and more.
2. Edit inline using the toolbar on the right. Changes preview instantly.
3. Drag the list to reorder blocks into the structure you want.
4. Export your finished README as Markdown and drop it straight into your repository.

Tip: keep the source of truth in README.md and regenerate it from drawy whenever your project changes.

Available scripts

Command	Description
bun run dev	Start the dev server with HMR
bun run build	Type-check and build for production
bun run preview	Preview the production build locally
bun run lint	Lint and format with Biome
bun run typecheck	Run the TypeScript compiler in check mode
bun run test	Run the test suite

Tech stack

Frontend · React + TypeScript, Vite, Tailwind CSS, Zustand, TanStack Query
Backend · Supabase (Auth + Postgres), Zod for runtime validation
Tooling · Biome (lint + format), ESM-only, Bun as the package manager

Project structure

drawy/
├── src/
│   ├── components/   # Blocks, toolbar, drag-and-drop list
│   ├── hooks/        # TanStack Query hooks and shared logic
│   ├── lib/          # Supabase client, schema, Markdown export
│   ├── stores/       # Zustand state stores
│   └── routes/       # App routes and layouts
├── public/
├── AGENTS.md         # Guidance for AI coding agents
└── README.md

Contributing

Contributions are welcome. To get started:

1. Fork the repository and create a branch: git checkout -b feat/my-feature
2. Make your change and add tests where it makes sense.
3. Run the checks: bun run lint && bun run typecheck && bun run test
4. Commit using Conventional Commits (feat:, fix:, docs: …).
5. Open a pull request with a clear description and a screenshot if the UI changed.

Please read AGENTS.md before submitting changes that touch architecture or shared state.

License

Released under the MIT License. See LICENSE for details.

This package is not published to npm — it is intended to be run locally or self-hosted.

---

All repository badges