statemachine-editor-react

Overview

This directory contains the React source for the OpenWorkflow web GUI. This is a pure front-end web GUI (no backend is needed). Everything is done in the browser with HTML, CSS, and Javascript. This Github page of this repository serves the compiled frontend code at https://cmusatyalab.github.io/OpenWorkflow/.

This project was bootstrapped with Create React App.

Install Dependencies

First install nodejs (npm).

# in current directory
npm install

Debug

1. npm start

   Runs the app in the development mode.
   Open http://localhost:3000 to view it in the browser.

   The page will reload if you make edits.
   You will also see any lint errors in the console.

Deployment

1. npm run build

   Builds the app for production to the build folder.
   It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.
   Your app is ready to be deployed!

   See the section about deployment for more information.

2. npm run deploy

   Deploy the application to the gh-page branch of this repository. This command updates https://cmusatyalab.github.io/OpenWorkflow/. You probably only want to do this for releases.

Generate Javascript protobuf library for Finite State Machine serialization/deserialization.

You would only need to do this if you changed the serialization format of OpenWorkflow finite state machine in wca-state-machine.proto.

1. Run gen-jspb.sh.
2. To generate the proper protobuf js, "/* eslint-disable */" needs to be added to the top of the file. The gen-jspb.sh script does this. See here.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.