Documentation and examples

You can find the majority of documentation in this manual.

API Documentation

You can find auto-generated documentation for the common core modules here:

• common
• client
• gui
• dialogs
• panels
• server
• event-emitter

Example Packages

• https://github.com/os-js/osjs-example-provider - A basic Service Provider example
• https://github.com/os-js/osjs-example-application - A basic Application package example
• https://github.com/os-js/osjs-example-iframe-application - A basic iframe Application package example
• https://github.com/os-js/osjs-example-react-application - A basic React application
• https://github.com/os-js/osjs-example-vue-application - A basic Vue application

Online Examples

For prototyping solutions you can use the following templates for online development environments:

• https://codesandbox.io/s/w6vrvzo03l
• https://codepen.io/andersevenrud/pen/bzowQX
• https://codepen.io/andersevenrud/pen/EGKNxV

A curated list of online examples for inspiration:

• https://codepen.io/collection/DqmrWo/
• https://codepen.io/collection/AybmNa/
• https://codesandbox.io/u/andersevenrud/sandboxes