Skip to content

datacontract/datacontract-editor

Repository files navigation

Data Contract Editor

A web-based editor for creating and managing data contracts using the Open Data Contract Standard (ODCS).

Screenshot

Features

  • Open Data Contract Standard: ODCS is the industry-standard for data contracts. Now with support for v3.1.0.
  • Editing Modes:
    • Visual Editor: Define data models and relationships using a visual interface
    • Form Editor: Get guided input with a simple form interface
    • YAML Editor: Edit data contracts directly in YAML format with code completion
  • Preview: Live preview of data contracts as HTML
  • Validation: Get instant feedback on your data contracts
  • Test: Test your data contract directly against your data using the Data Contract CLI API Server.

Usage

Web Editor

Open the editor as web application:

https://editor.datacontract.com

Standalone Application

You can start the editor locally using the following command:

npx datacontract-editor

Or edit a data contract file directly:

npx datacontract-editor mydatacontract.odcs.yaml

Docker

Run the editor locally in a Docker container:

docker run -d -p 4173:4173 datacontract/editor

Then open http://localhost:4173

Data Contract CLI

Coming soon!

You can start the editor from the Data Contract CLI:

datacontract editor datacontract.yaml

Entropy Data

The Data Contract Editor is fully integrated in our commercial product Entropy Data to manage multiple data contracts in a single application.

License

This project is maintained by Entropy Data and licensed under the MIT LICENSE.

About

Data Contract Editor

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 7

Languages