Merge pull request #114 from egekorkan/chore-administrative-fixes

Build and Package.json Fixes

Author: spf00

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

@@ -11,11 +11,11 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: "20"
-      - run: npm install
-      - run: npm run build
+      - run: yarn install
+      - run: yarn build
       - name: Deploy 🚀
         uses: JamesIves/github-pages-deploy-action@3.7.1
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           BRANCH: gh-pages
-          FOLDER: build
+          FOLDER: dist

.gitignore

@@ -29,6 +29,5 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-yarn.lock
 .yarn
 /doc/tests

README.md

@@ -7,20 +7,6 @@ Find the ediTDor here to try it out:
 
 https://eclipse.github.io/editdor/
 
-## Building the App
-
-There are two ways this app can be built. One way would be for using it as a standalone application, the
-other one for using it embedded into a production environment.
-The available environment variables are:
-
-```bash
-REACT_APP_IS_STANDALONE={flag} # true or false
-```
-
-If the REACT_APP_IS_STANDALONE environment variable is set to true, REACT_APP_HOST and REACT_APP_PORT are going to be
-used for building the UIs target. Otherwise "/" is used.
-The package.json already contains build options for this (build, build-standalone).
-
 ## 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
@@ -50,16 +36,14 @@ Please follow our [contribution guide](./CONTRIBUTING.md).
 
 - [Node.js](https://nodejs.org/), version 10+ (e.g., 10.13.0 LTS)
 
-## Start Locally
-
-`yarn dev` starts a local development server on Port 3000 (http://localhost:3000)
-
 ## Build
 
 `yarn install` install 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)
+
 ## Implemented Features:
 
 - JSON Editor with JSON Schema support for TD (Autocompletion, JSON Schema Validation)

package.json

@@ -4,10 +4,15 @@
   "version": "0.7.0",
   "type": "module",
   "homepage": "https://eclipse.github.io/editdor/",
+  "license": "EPL-2.0 OR W3C-20150513",
+  "author": "Eclipse ediTDor <editdor-dev@eclipse.org>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eclipse/editdor.git"
+  },
   "scripts": {
     "dev": "cross-env REACT_APP_TARGET_URL=http://localhost:8080 vite",
     "build": "vite build",
-    "build-standalone": "cross-env REACT_APP_TARGET_URL= vite build",
     "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview",
     "format": "prettier --write ."

src/components/TDViewer/TDViewer.jsx

@@ -47,14 +47,6 @@ export default function TDViewer() {
     addFormDialog.current.openModal();
   };
 
-  useEffect(() => {
-    try {
-      setTd(JSON.parse(context.offlineTD));
-    } catch (e) {
-      console.debug(e);
-    }
-  }, [context.offlineTD]);
-
   const onDrop = useCallback(
     (acceptedFiles) => {
       const file = acceptedFiles[0];

src/main.jsx

@@ -1,13 +1,10 @@
 import React from "react";
 import ReactDOM from "react-dom/client";
 import "./index.css";
-import { initializeTargetUrl } from "./services/targetUrl";
 import App from "./App";
 
 // require('string-direction').patch();
 
-initializeTargetUrl();
-
 const root = ReactDOM.createRoot(document.getElementById("root"));
 root.render(
   <React.StrictMode>

src/services/targetUrl.ts

@@ -27,52 +27,4 @@ const setTargetUrl = (targetUrl: string): void => {
   localStorage.setItem(TARGET_URL_KEY, targetUrl);
 };
 
-/**
- * @description
- * Initializes the target url if not already done.
- *
- * If a REACT_APP_TARGET_URL is provided through an ENV variable, it is assumed
- * that the UI is hosted as a standalone application. If not, it is assumed
- * that it runs as part of another application, e.g. an intermediary or thing
- * directory. In this case, the target url is initialized according to the host
- * address the UI is running on.
- *
- * To start the UI without a target url and configure it to simply use file
- * handles for persisting, provide an empty "REACT_APP_TARGET_URL=" environment
- * variable.
- *
- * @returns void
- */
-const initializeTargetUrl = (): void => {
-  let targetUrl: string | null = localStorage.getItem(TARGET_URL_KEY);
-  if (targetUrl !== null) {
-    console.debug(
-      `didn't initialize target url - already initialized as '${targetUrl}'`
-    );
-    return;
-  }
-
-  if (process.env.REACT_APP_TARGET_URL) {
-    targetUrl = process.env.REACT_APP_TARGET_URL;
-    if (!targetUrl?.endsWith("/")) {
-      targetUrl = targetUrl + "/";
-    }
-
-    localStorage.setItem(TARGET_URL_KEY, targetUrl);
-    console.debug(
-      `initialized target url from environment variable as '${targetUrl}'`
-    );
-    return;
-  }
-
-  const windowUrl = new URL(window.location.href);
-
-  targetUrl = `${windowUrl.protocol}//${windowUrl.host}`;
-
-  localStorage.setItem(TARGET_URL_KEY, targetUrl);
-  console.debug(
-    `initialized target url from production host as '${targetUrl}'`
-  );
-};
-
-export { getTargetUrl, setTargetUrl, initializeTargetUrl };
+export { getTargetUrl, setTargetUrl };