/omnia3-samples

Samples repository for the OMNIA Platform version 3

Primary LanguageJavaScriptMIT LicenseMIT

OMNIA 3 Samples

Samples repository for the OMNIA Platform version 3.

Themes: Click here to get the available themes

Languages: Click here to get the available languages

Web Components: Click here to see the samples in action

Themes

Adding new themes

In order to add a new theme to a tenant, here's what you need to do:

  • Open the theme's .scss file (Example: Dark Theme .scss);
  • Copy all styles;
  • Create a new theme in the Modeler and paste styles;
  • Clean & Build your application.

Web Components

Using storybook

We are using Storybook to create a gallery of ready-to-use Web Components.

If you want to develop your own Web Component using this environment, you should:

  • Clone or download the repository;
  • Install the packages (inside the webcomponents folder, run the command npm install);
  • Open the webcomponents folder in your code editor;
  • Inside the web-components folder you have all the available Web Components;
  • To try it in your local machine, run the command npm run storybook.

If you want to add and test a new Web Component, you should:

  • Add a new folder to the web-components folder;
  • Inside the Web Components's folder you must have three files:
    • *.js: Contains the Web Component code;
    • *.stories.js: Contains the Storybook's stories;
    • readme.md: The Web Component's documentation.

Build static storybook site

Run In the command line npm run build-storybook

Documentation

You can find documentation at https://docs.omnialowcode.com/.

Contributing

See contribution Guidelines here.

Information about creating Web Components can be found here.

License

OMNIA 3 Samples are available under the MIT license.