Options
All
  • Public
  • Public/Protected
  • All
Menu

@youwol/flux-core

flux-core

Maintenance License: MIT

Foundation library for Flux applications

Installation, Build & Test

To install the required dependencies:

yarn 

To build for development:

yarn build:dev

To build for production:

yarn build:prod

To test:

yarn test

To generate code documentation:

yarn doc

Usage

The primary usage of flux-core is to provide the foundation to create modules for the YouWol's low code solution Flux. An illustrated and commented example can be found here

Documentation

The documentation of the code is still a work in progress, in particular it is not yet as well organized as we would like it to be.

For new comers we recommend to start with the page core-concepts referenced in the right panel of the landing page (after having generated the doc, the landing page is in /dist/docs/index.html).

Generated using TypeDoc