| 1 | # Engage-UI [](https://travis-ci.org/emgage/engage-ui)
|
| 2 |
|
| 3 | #### Engage-UI is a React component library designed to help developers and designers creater the delightful web experiences.
|
| 4 |
|
| 5 | ### Installation:
|
| 6 | *Note: Yarn is not supported to @types/react conflicts among packages*
|
| 7 | 1. Install latest version of node & npm: https://nodejs.org/en/download/
|
| 8 | 2. `npm install typescript tslint -g`
|
| 9 | 3. If there is previously installed packages follow below procedures else jump on 5th point:
|
| 10 | a. `rd /s /q node_modules`
|
| 11 | b. `npm cache clear --force`
|
| 12 | 4. `npm i`
|
| 13 |
|
| 14 | ## Building and Running
|
| 15 | `npm run build-dev`: This will build the source code in development mode.
|
| 16 | `npm run build-release`: This will build the source code in production mode.
|
| 17 | `npm run test`: This will run all unit tests
|
| 18 | `npm run check`: This will run all the checks, including lint, build, unit tests.
|
| 19 | `npm run example`: This will the example application in ./example/src for testing purposes.
|
| 20 |
|
| 21 | Additional commands can be found in package.json.
|
| 22 |
|
| 23 | ## Documentation
|
| 24 | `npm run docs`: This will run the documentation application which documents all the components.
|
| 25 |
|
| 26 | ## Licenses
|
| 27 | * Source code is licensed under [MIT](https://opensource.org/licenses/MIT)
|
| 28 | * All icons and images are licensed under [Creative Commons Attribution-NoDerivatives 4.0](http://creativecommons.org/licenses/by-nd/4.0/)
|
| 29 |
|
| 30 | ## Feedback
|
| 31 | [Create an issue or feature request](https://github.com/emgage/engage-ui/issues/new).
|