LogigatorEditor

Getting Started

Prerequisites

You need to have node and npm installed to use this module. We recommend installing it via nvm:

Debian

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.1/install.sh | bash
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
nvm install lts/*

Installation

Download the contents of the repository, open the command line in that directory and install all required dependencies using npm install.

Linux / Unix

git clone 'https://github.com/logigator/logigator-editor.git' && cd ./logigator-editor && npm install

To start the app in your browser run:

npm start

The app will be served at localhost:8202
You can also run the app on your local PC using Electron

npm run start:electron

If you want to use the Backend, which is required for login and saving projects, you must also setup Logigator-Backend. Instructions for doing so can be found in the logigator-development-distribution.

Using the Simulation-Code

If the simulation-mode is not working, is this most likely due to a missing Webassembly module. To fix this issue you must build the Simulation Code by your self. Instructions for doing so can be found in the simulation repo. After you built the simulation-code, just copy the contents of logigator-simulation/webAssembly/dist/ to src/assets/wasm.

Building the App

Browser: npm run build
Electron: npm run build:electron:*platform*

Publishing

The App is automatically published to the web when code is pushed to the master branch.
To release a new version of electron create a tag the version number in the master branch. The tag must match the version found in package.json.
Before merging to master please update the version in package.json.

License

This Project is licensed under the MIT License - see the LICENSE file for details