Schema Builder Documentation

Welcome to the Schema Builder documentation! This guide will help you understand and effectively use the Schema Builder application.

What is Schema Builder?

Schema Builder is a modern web application that helps developers create database schemas visually and generate corresponding code automatically. It supports both NoSQL (MongoDB) and SQL database formats, making it versatile for different project needs.

Key Benefits

• Visual Design: Build schemas without writing code
• Type Safety: Generate TypeScript interfaces automatically
• Validation: Create Zod schemas with smart defaults
• Multi-Database: Support for both NoSQL and SQL databases
• Real-time: See generated code instantly as you build

Quick Start

1. Install dependencies: npm install
2. Start development server: npm run dev
3. Open browser: Navigate to http://localhost:3000
4. Create your first schema: Use either the Form Builder or JSON Editor
5. Generate code: View the automatically generated TypeScript, Zod, and database models

Documentation Sections

• Getting Started - Installation and setup
• User Guide - How to use the application
• Schema Format - Understanding schema structure
• Code Generation - Generated code examples
• API Reference - Technical reference
• Examples - Common use cases and examples
• Troubleshooting - Common issues and solutions

Need Help?

• Check the Troubleshooting Guide for common issues
• Review Examples for inspiration
• Open an issue on GitHub for bugs or feature requests