Merge pull request #98 from eclipse/chore/port-gitlab-changes

chore: port changes from gitlab

Author: fexpal

.github/workflows/publish-to-gh-pages.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '14'
+          node-version: '20'
       - run: npm install
       - run: npm run build
       - name: Deploy 🚀

.prettierrc

@@ -0,0 +1,23 @@
+{
+    "arrowParens": "always",
+    "bracketSpacing": true,
+    "endOfLine": "lf",
+    "htmlWhitespaceSensitivity": "css",
+    "insertPragma": false,
+    "singleAttributePerLine": false,
+    "bracketSameLine": false,
+    "jsxBracketSameLine": false,
+    "jsxSingleQuote": false,
+    "printWidth": 80,
+    "proseWrap": "preserve",
+    "quoteProps": "as-needed",
+    "requirePragma": false,
+    "semi": true,
+    "singleQuote": false,
+    "tabWidth": 4,
+    "trailingComma": "es5",
+    "useTabs": true,
+    "embeddedLanguageFormatting": "auto",
+    "vueIndentScriptAndStyle": false,
+    "parser": "babel"
+}

README.md

@@ -7,6 +7,14 @@ 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:
+```bash
+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
@@ -33,6 +41,10 @@ All systems require the following:
 
 * [NodeJS](https://nodejs.org/) 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)
 
@@ -41,7 +53,8 @@ All systems require the following:
 
 `npm build` builds the project for deployment
 
-## Implemented Features: 
-* JSON Editor with JSON Schema support for TD (Autocompletion, JSON Schema Validation)
+## 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)