diff --git a/README.md b/README.md index a4d46bc..8e75700 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,74 @@ +
+
+
+
+ + + +
+
+ +[https://zod-playground.vercel.app/](https://zod-playground.vercel.app/) + +
+
+
+ +
+ # Zod Playground -Zod Playground is a web app that allows users to play with the Zod API. Users can define a schema and test the validation of given values. The app is designed to be user-friendly and easy to use. It is a great tool for developers who are working with the Zod API and want to test their code. -## Getting Started -To get started with Zod Playground, you will need to have Node.js and npm installed on your machine. Once you have these installed, you can clone the repository and run the following commands: +Zod Playground is a web app that allows users to interact with the Zod library API. +Users can define schemas and test the validation of given values. +The app is designed to be user-friendly and easy to use. +It is a great tool for developers who are working with the Zod API and want to test their code on the fly without having to set up Zod locally. + +## Use cases + +- **Learn by doing**: Zod Playground shows you the validation result in the panel on the right. +- **Test different Zod versions**: Switch between different versions of Zod using the version picker. +- **Share schemas and values**: Share your schema and values with other developers by clicking the Share button and sending the URL. +- **Debug complex schemas**: Add multiple values to debug complex schema validation results. +- **Schema development**: Any other activity related to building and updating Zod schemas. + +## Features + +- **Real-time validation** +- **Version switch** +- **Shareable links** +- **User-friendly interface** +- **Validation result panels** +- **User-friendly validation errors** +- **Dark/light mode** +## Contribute + +If you would like to contribute to Zod Playground, fork the repository and submit a pull request. +If you notice a bug or want to request a feature, feel free to open an issue. +Any kind of contribution is welcome. + +### Run locally + +To get started with Zod Playground development, you will need to have node.js and npm installed. + +```sh +git clone https://github.com/marilari88/zod-playground.git +cd zod-playground + +npm i # Install dependencies +npm run dev # Start the development server ``` -npm i -npm run dev + +### Test + +Zod playground uses Playwright to run E2E tests. +To run tests locally, execute the following commands: + +```sh +npm test:init +npm test ``` -This will start the development server and open the app in your default browser. -Contributing -If you would like to contribute to Zod Playground, please fork the repository and submit a pull request. We welcome contributions of all kinds, including bug fixes, new features, and documentation improvements. +## License + +This project is licensed under the MIT License. diff --git a/public/logo.svg b/public/logo.svg new file mode 100644 index 0000000..f1dd6da --- /dev/null +++ b/public/logo.svg @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + +