Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: port changes from gitlab #98

Merged
merged 3 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/publish-to-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 🚀
Expand Down
23 changes: 23 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -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"
}
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

Expand All @@ -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)
Loading
Loading