CONTRIBUTING.md

Contributing

This project is using an NX style monorepository that helps divide and map the project dependencies for each project.

The core modules are in the packages directory and the example apps are in the examples directory. In order to figure out the commands you need to run, you can use the nx command line tool.

You can also use the infix notation to run a target: nx [target] [project] [options, ...]

On the other hand, if you want to run a specific command in a package, you can use the nx run command. There are a lot of things defined in every project's project.json file:

To run a target:

yarn nx run [project][:target][:configuration] [options, ...]
yarn nx r [project][:target][:configuration] [options, ...]

In order to run a specific example, make sure you build the UI library beforehand and on each modification by running:

yarn build # build core package

yarn nx serve react # run the react example
yarn nx serve angular # run the angular example

Build and deploy react example

yarn nx build react # build the react example
yarn nx deploy react # deploys react example to gh-pages