up version

Author: PH111P

README.md

@@ -2,38 +2,13 @@
 
 # Installation instructions
 
-## Prerequisites
+Node.JS version 8 or higher and NPM version 5 or higher need to be installed on the system. A Unix like OS especially Linux is recommended.
+Install dependencies by running `npm install` in the `frontend` folder of the project directory.
 
-Node.JS version 8 or higher and NPM version 5 or higher need to be installed on the system. GNU+Linux is recommended. 
-Make sure you populated the correct and up-to-date submodules installed. If you don't have the SOSML-frontend repository cloned yet use this to also get the submodules:
-```
-git clone --recursive https://github.com/SOSML/SOSML-frontend.git
-```
-If you have the the SOSML-frontend repository but not its submodules (e.g. if you cloned without `--recursive`):
-```
-git submodule update --init --recursive
-```
+Further, build a version of `SOSML/SOSML` and place the resulting `interpreter.min.js` as
+`interpreter.js` in the `frontend/public` folder. Similarly, build a version of `SOSML/SOSML-webworker`
+and put the result as `webworker.js` in the `frontend/public` folder.
+(Note that per default, a fairly recent version of both files is provided already.)
 
-## Install/Update all NPM dependencies
-To install or(non-exclusive or) update all NPM dependencies and pull all git submodules run:
-```
-./prepare.sh
-```
-
-## Build the interpreter and frontend
-
-Now you should have beautiful typescript code. To make javascript out of this repo and the submodules run:
-```
-./build.sh
-```
-
-## Install docker
-
-Install the latest version of docker on your system and make sure the docker daemon is running.
-Run `docker pull derjesko/mosmlfallback` to dowload the docker image.
-
-## Run the server
-
-Switch to the `backend` folder. Run `npm install`.
-Ensure that the user running the backend is in the `docker` group.
-Run `node ./src/main.js`. In parallel, run `node ./src/worker.js` to start a worker.
+If you want a built for deployment version just run `npm run build` and you can then find this version in the build folder.
+For developing on this repo just run `npm run start` which launches a version of the website in this repo and automatically updates if it detects changes in any project files.

frontend/package.json

@@ -1,53 +1,56 @@
 {
-  "name": "sosml-frontend",
-  "version": "1.0.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/SOSML/SOSML-frontend.git"
-  },
-  "description": "A frontend for the infamous SOSML interpreter",
-  "license": "GPL-3.0",
-  "dependencies": {
-    "@types/jest": "^20.0.8",
-    "@types/node": "^8.10.58",
-    "@types/react": "^16.9.11",
-    "@types/react-bootstrap": "^0.31.2",
-    "@types/react-dom": "^16.9.4",
-    "@types/react-router": "^4.0.15",
-    "@types/react-router-dom": "^4.0.7",
-    "file-saver": "^1.3.3",
-    "react": "^15.6.1",
-    "react-bootstrap": "^0.31.3",
-    "react-codemirror": "^1.0.0",
-    "react-dom": "^15.6.1",
-    "react-router": "^4.2.0",
-    "react-router-bootstrap": "^0.24.4",
-    "react-router-dom": "^4.2.2",
-    "react-scripts": "^3.2.0",
-    "react-splitter-layout": "^0.2.1"
-  },
-  "scripts": {
-    "start": "npm run version-ts; react-scripts start",
-    "build": "npm run version-ts; react-scripts build; workbox generateSW workbox-config.js && precompress build",
-    "test": "react-scripts test --env=jsdom",
-    "version-ts": "echo \"export const REF_NAME = '${CI_COMMIT_REF_NAME}';\nexport const COMMIT_SHA = '`git rev-parse --short HEAD`';\nexport const PIPELINE_ID = '${CI_PIPELINE_ID}';\nexport const BUILD_DATE = '`date --utc`';\" > ./src/components/Version.tsx"
-  },
-  "devDependencies": {
-    "precompress": "^5.1.0",
-    "tslint": "^5.0.0",
-    "typescript": "^3.7.0",
-    "workbox-cli": "^4.3.1"
-  },
-  "browserslist": {
-    "production": [
-      ">0.2%",
-      "not dead",
-      "not op_mini all"
+    "name": "@sosml/frontend",
+    "version": "1.2.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/SOSML/SOSML-frontend.git"
+    },
+    "description": "A frontend for the infamous SOSML interpreter",
+    "license": "GPL-3.0",
+    "files": [
+        "build"
     ],
-    "development": [
-      "last 1 chrome version",
-      "last 1 firefox version",
-      "last 1 safari version"
-    ]
-  }
+    "dependencies": {
+        "file-saver": "^1.3.3",
+        "react": "^15.6.1",
+        "react-bootstrap": "^0.31.3",
+        "react-codemirror": "^1.0.0",
+        "react-dom": "^15.6.1",
+        "react-router": "^4.2.0",
+        "react-router-bootstrap": "^0.24.4",
+        "react-router-dom": "^4.2.2",
+        "react-scripts": "^3.2.0",
+        "react-splitter-layout": "^0.2.1"
+    },
+    "scripts": {
+        "start": "npm run version-ts; react-scripts start",
+        "build": "npm run version-ts; react-scripts build; workbox generateSW workbox-config.js && precompress build",
+        "test": "react-scripts test --env=jsdom",
+        "version-ts": "echo \"export const REF_NAME = '${CI_COMMIT_REF_NAME}';\nexport const COMMIT_SHA = '`git rev-parse --short HEAD`';\nexport const PIPELINE_ID = '${CI_PIPELINE_ID}';\nexport const BUILD_DATE = '`date --utc`';\" > ./src/components/Version.tsx"
+    },
+    "devDependencies": {
+        "@types/jest": "^20.0.8",
+        "@types/node": "^8.10.58",
+        "@types/react": "^16.9.11",
+        "@types/react-bootstrap": "^0.31.2",
+        "@types/react-dom": "^16.9.4",
+        "@types/react-router": "^4.0.15",
+        "@types/react-router-dom": "^4.0.7",
+        "precompress": "^5.1.0",
+        "tslint": "^5.0.0",
+        "typescript": "^3.7.0",
+        "workbox-cli": "^4.3.1"
+    },
+    "browserslist": {
+        "production": [
+            ">0.2%",
+            "not dead",
+            "not op_mini all"
+        ],
+        "development": [
+            "last 1 chrome version",
+            "last 1 firefox version",
+            "last 1 safari version"
+        ]
+    }
 }