System Runtime

System Runtime

  • Languages iconENGLISH
    • Română
    • Help Translate
  • SUPPORT
  • GITHUB

›Guides

Introduction

  • What is System Runtime ?
  • System Runtime architecture
  • What is Design First ?
  • Overview

Guides

  • Quick Start
  • How to install System Runtime
  • Design your model
  • Create components
  • Manage your components
  • Bundle your system
  • Extend System Runtime
  • Go deeper

Examples

  • A basic "hello world"
  • Create a bundle
  • Install a bundle client-side
  • Install a bundle in HTML
  • Install a bundle server-side
  • Package a bundle
  • Create a component
  • Create new types
  • Create a one to one relationship
  • Create a one to many relationship
  • Navigate through the model
  • Inheritance between components
  • Listen to a change of state of a component
  • Use System Runtime NoSQL Database
  • Object-Document Mapper in action
  • Use System Runtime core apis
  • Use System Runtime history apis
  • Quick Start example

APIS

  • Component Class
  • runtime Component
  • metamodel Component
  • logger Component
  • db Component
  • history Component
  • Document Collection

About

  • Who is behind System Runtime ?
  • License

Extend System Runtime

There are many ways to add new functionalities to System Runtime. To do so you can:

  • update its source code,
  • add addons or
  • add extensions.

Update System Runtime source code

Installation

To update System Runtime, you will need to clone the repository:

git clone https://github.com/design-first/system-runtime.git

Once you have cloned the repository, install the dependencies:

npm i

Development mode

Start System Runtime in development mode:

npm run dev

All the modifications to the source code of System Runtime will build System Runtime core module.

Update source code

System Runtime has got a customizable core system. You can update all its components, models or behaviors to follow your needs. To do so:

  • open a version of System Designer,
  • import System Runtime core system on the /src/system directory,
  • edit the system,
  • export it,
  • save it in the same place.

Because you have changed the source code, System Runtime will be automatically rebuild in development mode.

Build

Once you have finished all your modification, you can build System Runtime:

npm run build

It will:

  • build System Runtime core module for the server library and
  • build System Runtime client library on the /dist directory

Add addons

You can also update System Runtime core system by composing other systems with it. In that case, other systems are called addons.

To compose a system with System Runtime core systems, just copy and paste a system into the /src/addons directory and build System Runtime.

Add extensions

You can extend System Runtime core system by composing other systems at runtime. In that case, these systems are called extensions.

To add an extension, just install it at runtime.

Install an extension client-side

Just add a link tag in your HTML to install and start your extension:

<!-- install your extension -->
<link rel="system" type="application/json" href="storage.json">

Install an extension server-side

Just call install API to install and start your extension:

// install your extensions 
runtime.install('storage.json');

Conclusion

We saw in that article:

  • how to build System Runtime,
  • how to update System Runtime source code,
  • how to add addons and
  • how to add extensions.

In the last article, we will go deeper in the use of System Runtime.

← Bundle your systemGo deeper →
  • Update System Runtime source code
    • Installation
    • Development mode
    • Update source code
    • Build
  • Add addons
  • Add extensions
    • Install an extension client-side
    • Install an extension server-side
  • Conclusion
System Runtime is distributed under Apache License 2.0 - Copyright © 2024 Erwan Carriou