openexo design system ·

The goal of Openexo design system

Our goal is create a library for building reusable components to build faster, more autonomously and keep the consistency in the whole platform.

• Design: Create interactive UIs.
• IT: Build UI components to manage their own state, then compose them to make complex UIs.

Available features

Feature	Notes	Docs
Button		Docs
Button-toggle		Docs
toolbar		Docs

Contributing

If you'd like to contribute, you can create an issue or contribute with a Pull request

Development

Getting started

• Run npm run build:lib to generate the UI library.
• Run npm start to serve the demo app in a dev server.
• Navigate to http://localhost:4200/.
• The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

• Run npm run build to build the demo project. The build artifacts will be stored in the dist/dev-demo directory.
• Run npm run build:lib to build the library project. The build artifacts will be stored in the dist/dev directory.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Testing

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Style guide

We follow the tslint-airbnb and codelyzer, you can see in tslint.json

{
  "extends": ["tslint-config-airbnb"],
  "rulesDirectory": [
    "node_modules/codelyzer"
  ]
}

To run the lint you should run npm run lint.

We have prettier to enforces a consistent style, you should run npm run format:check.