- - + +

Run when developing

+ + + +

Run when developing

I have made a simple script, that can be run both on a rPI and a normal computer. (You will obviously not get any script to do anything on you pc)

I have only tested this on my mac...

To start it run: -
1
npm run dev -
-
+

npm run dev
+

You have to run these commands beforehand: -

1 -2	npm i + `npm i pip3 install mkdocs mkdocs-gitbook pygments pymdown-extensions -` `-`

Starting

It will when starting freak out a little. All the filewatchers fires an event for every file, they find for some reason. But node should be killed each time, and when you end up with only two processes, it should work as you'd expect.

This will create a folder named tmp in you working directory. where all the user-files will be stored.

Build watcher.

It starts to watch these directories: -
1
- /build/ -
-
+

- /build/
+

If a change is detected, it runs: -

1	mkdocs build - -

mkdocs build
+

Node watcher

It starts to watch these directories: -
1 -2
- src/ (Except /src/public/ and /src/js/) -- app.js -
-

- src/ (Except /src/public/ and /src/js/)
+- app.js
+

It then shuts down node and starts it again: -
1
node app.js <WORKING_DIR>/tmp/ -
-

node app.js <WORKING_DIR>/tmp/
+

webpack

It just starts this command, witch rebundles when anything is changed: -
1
npx webpack -p -w --mode=development -
-

npx webpack -p -w --mode=development
+

Inteface

fsWatch-window: logs when one of the watchers (not webpack obv.) detects a filesystem-change. NODE means node-watcher, and DOCS means docs-watcher.
Actions-window: Logs all events with processes, like starting one, when one exits, when we try to kill one etc.
Node-window: Shows the output of node.
mkDocs-window: Show the output from running mkDocs.
Active Processes-table: Shows a table of currently active processes started by the app. Use arrow keys to navigate it.
Webpack-window: Shows the output from our webpack-process.

Tip

All the log-windows respond to holding your cursor over and scrolling.

`Exit`

The script will exit when pressing q, s, escape, Control+c. +

`Exit`

The script will exit when pressing q, s, escape, Control+c. It will then send a kill signal to all processes, wait 10 seconds and then exit.

Edit file-watchers.

Each of the file-watchers have explanatory names: watcher_node and watcher_docs.

To add files or paths they should watch, find the init of the variable, and modify that code: -
1 -2 -3 -4 -5 -6
e.g. -let; watcher_node = chokidar.watch([ - "app.js", - 'src/' // Add new entrys here - -]).on('all', (event, path) => { // ... -
-

For the node-watcher, specify paths it should ignore in the path.includes block.

- - - - - - +

e.g.
+let; watcher_node = chokidar.watch([
+    "app.js",
+    'src/'  // Add new entrys here
 
+]).on('all', (event, path) => { // ...
+

For the node-watcher, specify paths it should ignore in the path.includes block.

- -

- - + +

SocketIO

+ + + +

SocketIO

Client

Socketio is setup in the file globals. -This means, import globals, and then you can use Socket from there.

Socketio is setup in the file globals. +This means, import globals, and then you can use Socket from there.

Connect

Client first needs to get an Authentication token, this can be obtained by doing this: -

1
-2
-3
-4
-5
-6
-7
-8
-9

import {setCookie} from "../../../cookies";
-let CryptoJS = require("crypto-js");
-let passwordHash = CryptoJS.SHA256(<PASSWORD>;).toString();
-
-Socket.emit("authenticate", <USERNAME>, passwordHash, (token) => {
-    // Token will be a string if username/password combo is right,
-    // if not, it is false.
-    setCookie("session_token", token, 500);
-};)
-

import {setCookie} from "../../../cookies";
+let CryptoJS = require("crypto-js");
+let passwordHash = CryptoJS.SHA256(<PASSWORD>;).toString();
+
+Socket.emit("authenticate", <USERNAME>, passwordHash, (token) => {
+    // Token will be a string if username/password combo is right,
+    // if not, it is false.
+    setCookie("session_token", token, 500);
+};)
+

Then the user can authenticate like this: -

1
-2
-3
-4
-5
-6
-7

import {getCookie} from "../../../cookies";
-let cookieToken = getCookie("session_token");
-
-Socket.emit("authenticateToken", cookieToken, (res) => {
-    // Res is true if we got authenticated,
-    // If not, it is false.
-});
-

import {getCookie} from "../../../cookies";
+let cookieToken = getCookie("session_token");
+
+Socket.emit("authenticateToken", cookieToken, (res) => {
+    // Res is true if we got authenticated,
+    // If not, it is false.
+});
+

We are now authenticated, and all actions and events are available to the client.

"Actions"

1 -2	Socket.emit(Action, *Arguments, (Return) => { -};) - -

- +

Socket.emit(Action, *Arguments, (Return) => {
+};)
+

NeoRuntime/status

@@ -747,7 +700,9 @@ This means, import globals

Return/status

@@ -775,7 +730,9 @@ This means, import globals

NeoRuntime/Script/Create

Arguments

Name

Arguments

@@ -792,7 +749,9 @@ This means, import globals

Name

Return

@@ -815,7 +774,9 @@ This means, import globals

NeoRuntime/Script/Delete

Arguments

Name

Arguments

@@ -832,7 +793,9 @@ This means, import globals

Name

Return

@@ -855,7 +818,9 @@ This means, import globals

NeoRuntime/Script/Select

Arguments

Name

Arguments

@@ -873,7 +838,9 @@ This means, import globals

NeoRuntime/Scripts/get

Return

Name

Return

@@ -896,81 +863,78 @@ This means, import globals

"Events"

Name

1
-2
-3
-4
-5

// Listen for a event
-Socket.emit(event + "::join");
-Socket.on(event, (*Return); => {
-
-})
-

1 -2	// Stop listening for an event -Socket.emit(event + "::leave") - -

// Listen for a event
+Socket.emit(event + "::join");
+Socket.on(event, (*Return); => {
+
+})
+

// Stop listening for an event
+Socket.emit(event + "::leave")
+

Server

- - - - - - - -

+ + + + +

Design

Design

CompileAndRun

Index

CompileAndRun

Index

Locals

var pythonSupportFiles

var pythonSupportFiles

Exported

class Python

class Python

method Python.constructor

method Python.constructor

method Python.compile

method Python.compile

method Python.run

method Python.run

Python

Entry.py

Run when developing

Run when developing

Build watcher.

Node watcher

webpack

Inteface

Exit

Exit

Edit file-watchers.

SocketIO

SocketIO

Client

Connect

"Actions"

NeoRuntime/status

NeoRuntime/Script/Create

NeoRuntime/Script/Delete

NeoRuntime/Script/Select

NeoRuntime/Scripts/get

"Events"

Server

var `pythonSupportFiles`

var `pythonSupportFiles`

class `Python`

class `Python`

method `Python.constructor`

method `Python.constructor`

method `Python.compile`

method `Python.compile`

method `Python.run`

method `Python.run`

`Exit`

`Exit`