Skip to content

eclipse/editdor

Repository files navigation

alt text Discord

A tool for simply designing W3C Thing Descriptions and Thing Models

Find the ediTDor here to try it out:

https://eclipse.github.io/editdor/

About this project

This project aims to make creating W3C Thing Description instances and Thing Models easy by providing a platform-independent ediTDor tool. The following features are addressed in this project

  • Creating a new Thing Description / ThingModel from scratch
  • Rendering a Thing Description / Thing Model
  • Editing the Thing Description / Thing Model
  • Validating the Thing Description / ThingModel
  • Exporting the Thing Description / ThingModel from the visual representation into JSON-LD
  • Reading/writing exposed properties' values exposed by a proxy (anything that can translate a protocol to HTTP)

Technologies

  • React
  • TailwindCSS
  • Typescript

Contribution guide

Any contribution to this project is welcome. Please follow our contribution guide.

License

Prerequisites

  • Node.js, version 10+ (e.g., 10.13.0 LTS)

Build

yarn install installs all the dependencies listed within package.json

yarn build builds the project for deployment

yarn dev starts a local development server on Port 3000 (http://localhost:3000)

Development enviroment

In development environment it is possible to use react scan to detect performance issues by analyzing the pop up on the bottom right corner. The complete documentation is available here.

Implemented Features:

  • JSON Editor with JSON Schema support for TD (Autocompletion, JSON Schema Validation)
  • Add Property, Action, Event by wizard
  • Render TD to be more human-readable
  • Validate JSON Syntax and JSON Schema for TD (JSONLD and Additional Validation for nested TM will be implemented in the future)
  • Add a TM or TD via a CSV file (For now, Modbus only)

About

Eclipse ediTDor - A tool for simply designing W3C Thing Descriptions

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 10