nereumelo/zod-sandbox

README

Zod Sandbox

Welcome to the Zod Sandbox repository! This project is built using TypeScript, Vite, React, Tailwind CSS, CodeMirror, Flowbite, and Zod. It provides a playground environment for experimenting with Zod, a runtime type checking library for TypeScript.

Introduction
Features
Getting Started
Usage
Contributing
License

Introduction

The Zod Sandbox is a web application that allows you to interactively test and experiment with the Zod library. Zod is a powerful TypeScript-first library for data validation, parsing, and serialization. With this sandbox, you can quickly prototype and visualize how Zod schemas work with your data.

Features

Live editing of Zod schemas and data.
Syntax highlighting with CodeMirror.

Getting Started

Follow these steps to get the Zod Sandbox up and running on your local machine:

Clone the repository:

git clone https://github.com/your-username/zod-sandbox.git

Navigate to the project directory:
```
cd zod-sandbox
```
Install dependencies:
```
npm install
```
Start the development server:
```
npm run dev
```
Open your browser:

The development server should now be running. Open your web browser and navigate to http://localhost:5173 to access the Zod Sandbox.

Usage

Once the Zod Sandbox is running in your browser, you'll see the code editors on the left and a result panel on the right. You can start by writing your own data and Zod schema.

To see the validation results, click the "Validate" button or press the keys Ctrl + Enter. This will display the outcome of the validation process, helping you understand how Zod validates data against schemas.

Contributing

Contributions to the Zod Sandbox are welcome and encouraged! If you'd like to contribute, please follow these steps:

Fork the repository.
Create a new branch for your feature or bug fix: git checkout -b feature-name.
Make your changes and commit them with descriptive commit messages.
Push your changes to your fork.
Open a pull request to the main branch of the original repository.

Please ensure your code follows the project's coding standards and includes appropriate tests if applicable.

License

The Zod Sandbox is open-source software licensed under the GNU General Public License version 3 (GPLv3). Feel free to use, modify, and distribute it in accordance with the terms of the GPLv3 license.

Thank you for checking out the Zod Sandbox! If you have any questions or feedback, please don't hesitate to reach out.