Git Product home page Git Product logo

tutorials's Introduction

Tutorials

Source code for WebGME components; to be used in conjunction with WebGME Seminar tutorials.

Dependencies

To follow the tutorial the following dependencies need to be installed:

To host a webgme server:

After mongodb has been installed, start mongod (mongo deamon) at the default port 27017 and leave it running throughout the tutorial:

%Path\to\mongod.exe% --dbpath %Path\to\database\root\directory%

webgme-cli (v2.0.0), the tool for creating new webgme components (plugins, decorators, visualizers), needs to be installed globally as a node-module. Use the following command:

npm install -g webgme-cli

After installation check the version by entering webgme --version

The debug tools used during the tutorials:

N.B. livereload requires python 2.7 to be installed and available in path.

During the live tutorial we will use the IDE webstorm (30 days trial version is available), an open source alternative is atom.

Repository Structure

The repository is broken down into different sessions. Each session contains a README.md with an outline of what the session will cover. The folders _session*/FSM contain the files in the repository after the session has been completed.

When following the tutorial, it is recommended to start from the root of the repository, i.e. where this README.md file resides, and work from the generated FSM folder.

Goals

The goal of these tutorials is (1) to become familiar with using the webme-cli tool for creating components, and more importantly, (2) how to implement these components.

  • The first tutorial covers how to initialize a repository and get the server running. During the live session a small meta-model for finite-state machines will be built up, as well as an example instance model.

  • In the second tutorial, a model transformer - a WebGME plugin - will be written. It will use the model api (core-API) together with the FSM meta-model to gather the needed data to create a simulator class in javascript. This simulator will be saved back to the model and used in later sessions.

  • In the third tutorial, a decorator will be written, which defines how the model nodes are displayed for the user. Our decorator will inherit from the default ModelDecorator, and we will extend it to display a) the node's 'result' object, and b) if the result object is up-to-date. It will also provide a button for invoking the plugin from the previous tutorial.

  • In the fourth tutorial, a visualizer will be written, allowing users to access properties and artifacts of the models, and dynamically visualize the state of the model.

  • In the fifth tutorial video, we see how an existing model (and meta-model) can be attached to a new WebGME project as a library, allowing users to extend a modeling paradigm and build upon the instance models, without modifying the original model/meta-model.

tutorials's People

Contributors

kecso avatar jimklingler avatar

Watchers

James Cloos avatar Rahul Bhadani avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.