Collection of modules for Flux exposing RxJs operators.
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
You can find the documentation here
The YouWol project is open-source as much as possible, do not hesitate to contribute by creating branches and pull-requests.
The Youwol fullstack environment (YouWol FSE) should be used when developing flux-pack. It offers an immersive experience of the YouWol ecosystem, and lets you work with your favorite stack. Usually you've accessed this file using it anyway. All the links in what follows assumed you've started this environment.
Create a branch and includes the github folder into your workspace (as defined in your YouWol FSE's configuration file, under category 'flux-pack'). Reload the dashboard, the package should now be listed (My Computer=>Packages).
build, test & publish the package from the dashboard.
Start by creating a new flux-app:
Once opened, in the top builder-panel:
You can start iterate in the code, build, test & publish each time you want to test your features in Flux.
Documentation about designing modules in Flux can be found in the flux-core documentation.
In order to conveniently work within YouWol's environment, the following approach regarding versioning is recommended:
The CDN is accepting to override previous publish version, this is how the -next trick is working and allows for a smooth integrated experience. However, when a finalized version of your package is published (with no -next suffix), it is strongly recommended to not update the CDN content of your package anymore for this version.
If you plan to share your package, you'll need to publish it in a npm repository. For public or private needs, the choice of this repository is yours. For more advanced permission resolution related to YouWol's group, you'll need to use your YouWol's GitLab environment (not available yet).
Generated using TypeDoc