8000
Skip to content

tutkuofnight/schema-lens

Repository files navigation

🗃️ SchemaLens

SchemaLens is a powerful, interactive database schema visualizer tailored for modern developers. It instantly transforms your Drizzle ORM, Prisma, or generic SQL schemas into beautiful, interactive entity-relationship diagrams.

SchemaLens Banner

✨ Features

  • Multi-Format Support:
    • 🌧️ Drizzle ORM: Paste your Drizzle schema definitions directly.
    • 💎 Prisma: Visualize your schema.prisma files.
    • 🐘 SQL: Support for standard SQL CREATE TABLE statements.
  • Interactive Diagrams:
    • Drag and arrange tables to organize your view.
    • Zoom and pan to explore large schemas.
    • Auto-layout capabilities.
  • Real-time Parsing: See changes in the diagram instantly as you edit the code.
  • Code Editor: Integrated Monaco Editor for a premium coding experience.
  • Privacy Focused: All parsing happens client-side. Your schema code never leaves your browser.

🛠️ Tech Stack

Built with the latest modern web technologies:

🚀 Getting Started

Follow these steps to run SchemaLens locally on your machine.

Prerequisites

  • Node.js (v18 or higher)
  • Bun (Optional, but recommended as bun.lock is included)

Installation

  1. Clone the repository

    git clone https://github.com/tutkuofnight/schema-lens.git
    cd schema-lens
  2. Install dependencies Using Bun (recommended):

    bun install

    Or using npm:

    npm install
  3. Start the development server

    bun run dev
    # or
    npm run dev
  4. Open your browser Navigate to http://localhost:5173 to start using SchemaLens.

📖 Usage

< 7079 /a>
  1. Open the application.
  2. Select your schema format (Drizzle, Prisma, or SQL) from the sidebar.
  3. Paste your schema code into the editor on the right (or bottom on mobile).
  4. Watch the diagram generate automatically!
  5. Drag tables to rearrange them.

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

About

SchemaLens ~ Database and ORM Schema Visualizer for Developers and Vibe Coders

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

0