System Designer

System Designer

  • Languages iconΕλληνικά
    • English
    • Português (Brasil)
    • Svenska
    • 繁體中文
    • Help Translate
  • SUPPORT
  • GITHUB

›Tutorials

Introduction

  • What is System Designer?
  • What is Design First?
  • Quick Start
  • Quick Start in videos

Guides

  • Installation
  • Create a System
  • Create a Schema
  • Edit a model
  • Create a Behavior
  • Create a Type
  • Create a Component
  • Run your System
  • Export a System
  • Import a System
  • Generate a diagram
  • Sync your systems with GitHub
  • Design a remote client system
  • Design a remote server system
  • Manage Extensions
  • Extend System Designer
  • Shortcuts

Tutorials

  • List of Examples
  • Bundle your CSS
  • Bundle your JavaScript
  • Δέσμευση HTML
  • Test a server-side application
  • Create a NPM module
  • Create a website
  • Listen to a model event
  • Listen to a data store event
  • Send messages
  • Send messages to other systems
  • Create an extension
  • Generate a model from a JSON file
  • Create a Graph system

Articles

  • Άρθρα σχετικά με το έργο

About

  • Who is behind System Designer?
  • Privacy Policy
  • License
Translate

Create a NPM module

You can easily create a npm module with System Designer.

Configure your Github repository

  • go to Github,
  • create a repository to store your npm module,
  • go to the Personal Access Tokens page,
  • click on Generate new token button,
  • in Token Description type 'System Designer',
  • add repo scope,
  • click on Generate token button and
  • copy the generated key.

Configure System Designer

  • open the configuration panel,

Image Alt

  • in Github token paste your key,
  • in Github repository set the name of your repository (example: myname/myrepo ) and
  • click on 'Save' button.

Create your module

  • once you have created your system, open the Github panel,
  • add a comment,
  • click on Add a package.json file,

Image Alt

  • click on Execute button and
  • your system will be pushed in your Github repository with a package.json.

Publish your module

To publish your module:

  • clone your repository and
  • go to this documentation.

Use your module

First, you need to install System Runtime server-side:

npm install system-runtime --save

Install your module:

npm install mysystem --save

Then create a new file (mysystem.js for example) and call the install method of runtime:

const runtime = require('system-runtime');

// install and start the system
runtime.install('mysystem');
← Test a server-side applicationCreate a website →
  • Configure your Github repository
  • Configure System Designer
  • Create your module
  • Publish your module
  • Use your module
System Designer is distributed under Apache License 2.0 - Copyright © 2024 Erwan Carriou