Apiom component used to share common components between GO1 products. It also provide a live preview page as a styleguide.

Live preview

https://apiom.pages.go1.co/apiom-components/#/card

Development

To start development mode

npm run start

open http://localhost:8080 on browser to see the demo page

To generate production files

npm run build

Add new component with generator

Required

sed GNU

Install on OSX

brew install gnu-sed --with-default-names

Install on Windows

Run

./scripts/generator.sh COMPONENTNAME

Result

It should generate templates for:

• component files (ts, html and less)
• demo files (ts, html)

It should update

• app.ts to add new component
• demo.module.ts to add new demo component
• apiom-demo.config.ts to add new router for the demo component
• apiom-demo.html to add new menu item for the demo component

How can I contribue a component?

Should not think about create component for GO1, think about we are creating a component which will be used with different companies. So:

1. GO1 bussiness logic should not in the component
2. Should not send any request in components, the component should receive inputs and bind inputs change to outside world with an output