Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.51 KB

README.md

File metadata and controls

60 lines (42 loc) · 2.51 KB
Raw

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/

Using the AI Chat Function

The AI chat is currently implemented using Azures cognitive services API. To make use of the chat the app has to be compiled with two additional environment variables:

REACT_APP_OPENAI_KEY={api_key}
REACT_APP_OPENAI_URI={azure_resource_address}

About this project

The goal of this project is the easy creation of W3C Thing Description instances and Thing Models 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

Technologies

  • React
  • TailwindCSS

Contribution guide

Any contribution to this project is welcome. If you want to report a bug or question, please check the issue list or create a new issue. If you want to contribute to this project by coding, please follow the general contribution guidelines described here. Note that you need to have an Eclipse account to make Pull Requests.

License

Prerequisites

To use with Node.js

All systems require the following:

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

Install dependencies

npm install install all the dependencies listed within package.json

Start Locally

npm run start starts a local development server on Port 3000 (http://localhost:3000)

Build

npm install install all the dependencies listed within package.json

npm build builds the project for deployment

Implemented Features in the ediTDor:

  • JSON editor with JSON Schema support for TD (autocompletion)
  • 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 TMs will be implemented in the future)