An open API service indexing awesome lists of open source software.

https://github.com/trendyol/schema-craft


https://github.com/trendyol/schema-craft

json-schema nextjs reactjs schema-craft schema-generator typescript

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# 🛠️ SchemaCraft

SchemaCraft is a tool that allows you to convert a given JSON payload into a JSON schema based on the [2019-09 JSON Schema specification](https://json-schema.org/draft/2019-09/schema).

https://github.com/user-attachments/assets/afc87bc4-a035-4b56-80e9-6eb4a9f49dc5

## 📑 Table of Contents

- [Motivation](#motivation)
- [Features](#features)
- [Demo](#demo)
- [Run Locally](#usage)
- [Contributing](#contributing)

## 💡 Motivation

JSON Schema offers a standardized way to define structures, but creating schemas manually can be tedious and error-prone. **SchemaCraft** was built to solve this problem, providing a quick and reliable way to generate JSON schemas from any JSON payload. It's a tool designed to save time and ensure accuracy, making it easier for developers to work with structured data efficiently through a user friendly UI.

## ✨ Features

- 🚀 Convert any JSON payload to a valid JSON schema with a fancy way.
- 📜 Supports the 2019-09 JSON Schema draft specification.
- 💻 Easy-to-use interface.

## 💻 Demo

You can try it out with a live demo on https://schema-craft.vercel.app

## 🧰 Run Locally

### Prerequisites

- 🟢 [Node.js](https://nodejs.org/)
- 📦 [npm](https://www.npmjs.com/)

### Steps

1. Clone the repository

2. Install dependencies:

```bash
npm install
```

3. Start the development server:

```bash
npm run dev
```

4. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application.

## 🤝 Contributing

Contributions are welcome! Please do not forget to check [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) follow these steps:

1. 🍴 Fork the repository.
2. 🛠️ Create a new branch (`git checkout -b feature-branch`).
3. ✏️ Make your changes.
4. 💾 Commit your changes (`git commit -m 'Add some feature'`).
5. 🔄 Push to the branch (`git push origin feature-branch`).
6. 📥 Open a Pull Request.

Please ensure your code follows the project's coding guidelines and passes all tests before submitting.

## 📜 License

This project is licensed under the [MIT License](LICENSE).