Skip to content

README.md

Latest commit

 

History

History
180 lines (121 loc) · 4.54 KB

README.md

File metadata and controls

180 lines (121 loc) · 4.54 KB

Electron

The Electron-based shell for DFN v2.

First, follow instructions in the root directory for setup.

Start it

pnpm start

Start it dev mode

pnpm run start:dev

Compile TypeScript code

pnpm run compile

Build the static web page

pnpm run pack

Static web page is output to ./dist.

Build the installer

The installer requires a separate directory temporary outside the monorepo due to issues with pnpm. During the build process the project is exported to the temporary directory.

You need to set the parent of the temporary directory as an environment variable. Set it to any temporary location on your drive, you can delete the whole directory after the build:

export BUILD_PARENT_DIR=<a-tmp-dir>

Or on Windows:

set BUILD_PARENT_DIR=<a-tmp-dir>

Then run the build depending on which OS you are building on and for:

npm run build-win
npm run build-linux
npm run build-mac

After the build you can find the exported project under and under the subdirectory dfn-build. Under there drill down to the installer subdirectory and you'll find the installer that was built for DFN.

After you copy the installer out feel free to delete the temporary directory.

On Windows, if you see an error like the following you might have to close VS Code:

EPERM: operation not permitted, open 'C:\temp\dfn-build\tmp-eval-engine\node_modules\.bin\upgrade-blueprint-2.0.0-rename'

Important directories

Windows

  • Home directory: C:\Users<username>
  • Install directory: C:\Users<username>\AppData\Local\Programs\data-forge-notebook-v2
  • Exe path: C:\Users<username>\AppData\Local\Programs\data-forge-notebook-v2\data-forge-notebook-v2.exe
  • INSTALL_PATH: C:\Users<username>\AppData\Local\Programs\data-forge-notebook-v2
  • Node.js path: %INSTALL_PATH%\nodejs
  • Evaluation engine path: %INSTALL_PATH%\evaluation-engine
  • DATA_PATH: C:\Users<username>\AppData\Roaming\data-forge-notebook-v2
  • Settings directory: %DATA_PATH%
  • Log file: %DATA_PATH%\log.log
  • Temp path: C:\Users<username>\AppData\Local\Temp
  • Documents path: C:\Users<username>\Documents
  • Downloads path: C:\Users<username>\Downloads

Linux

  • Settings: $XDG_CONFIG_HOME/data-forge-notebook-v2 or ~/.config/data-forge-notebook-v2
  • Log file: ~/.config/data-forge-notebook-v2/log.log

MacOS

  • Home directory: /Users/
  • Install directory: /Applications/data-forge-notebook-v2.app/Contents
  • Exe path: /Applications/data-forge-notebook-v2.app/Contents/MacOS/data-forge-notebook-v2
  • INSTALL_PATH: /Applications/data-forge-notebook-v2.app/Contents
  • Nodejs path: $INSTALL_PATH/nodejs
  • Evalution engine path: $INSTALL_PATH/evaluation-engine
  • DATA_PATH: ~/Library/Application\ Support/data-forge-notebook-v2
  • Settings directory: $DATA_PATH
  • Log file: ~/Library/Logs/data-forge-notebook-v2/log.log
  • Temp path: /var/folders/by//T/
  • Documents path: ~/Documents
  • Downloads path: ~/Downloads

Run a local build from the dev evaluation engine

Set the environment variable to the path for the evaluation engine project:

set DEV_EVAL_ENGINE_DIR=c:\projects\data-forge-notebook\editor-core\shells\evaluation-engine

Run it this way:

pnpm run electron:static

Or this way:

pnpm run electron:dev

Note: Make sure you compile the evaluation engine first. Run pnpm run compile at the root of the mono-repo to compile everything.

Run a local build from the installed app data path

This picks up the installed version of Node.js and the evaluation engine.

Set the environment variable to the installed path:

On Windows:

set INSTALL_PATH=C:\Users\Ash\AppData\Local\Programs\data-forge-notebook-v2

On MacOS:

export INSTALL_PATH=/Applications/data-forge-notebook-v2.app/Contents

Run it this way:

pnpm run electron:static

Or this way:

pnpm run electron:dev

Setting the URL for the evaluation engine

Normally the electron build automatically spawns the evaluation engine. But you can also run it separately and instruct the electron build to connect to it using this environment variable:

set EVALUATION_ENGINE_URL=http://localhost:7000

When running the evaluation engine you must set the port to match:

set PORT=7000

Adding example notebook data

Add a new example notebook. Make sure it has a description set.

Then run this script to regenerate the example notebooks metadata:

pnpm run prep-examples

Then check and commit the update to ./src/data/example-notebooks.ts.