Please visit the ContainerJS website for information on getting started, and end-user API documentation.
This project is a mono-repo, i.e. multiple distinct projects within the same Git repository. This project uses Lerna to manage the dependencies between these projects and their release process.
To get started, run the following from the project root:
npm install
npm run build
This will install Lerna and run lerna bootstrap, which runs npm install on all the sub-projects, and links any cross dependencies.
If you want to see ContainerJS in action, the api-demo project has a fully-featured demo that can be run against various containers.
The ContainerJS repo contains the following:
api-specification- the ContainerJS API specified in TypeScript.api-browser,api-electron,api-openfin- various container-specific implementations of this API.api-bundle- a bundle that contains the client-side code for all of the different ContainerJS implementations. This allows exactly the same application code to be run against each container.api-tests- a common suite of UI automation tests that exercise the API.api-demo- a ContainerJS demo application.
The website can be found in the docs folder. It is a Jekyll site, which is hosted via GitHub. The API documentation is generated from the TypeScript interfaces within the api-specification package. To run this build execute the following:
npm run docs