You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://www.npmjs.com/package/@aurodesignsystem/auro-skeleton)
@@ -51,24 +51,22 @@ For the most up to date information on [UI development browser support](https://
51
51
$ npm i @aurodesignsystem/auro-skeleton
52
52
```
53
53
54
-
Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this [stack overflow](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `auro-skeleton__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported.
93
-
94
-
**WARNING!** When installing into your application environment, DO NOT use `@latest` for the requested version. Risks include unknown MAJOR version releases and instant adoption of any new features and possible bugs without developer knowledge. The `@latest` wildcard should NEVER be used for production customer-facing applications. You have been warned.
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.
In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.
135
123
136
124
Please be sure to review the [contribution guidelines](https://auro.alaskaair.com/contributing) for this project. Please make sure to **pay special attention** to the **conventional commits** section of the document.
@@ -139,42 +127,20 @@ Please be sure to review the [contribution guidelines](https://auro.alaskaair.co
Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the **dev server**.
144
132
145
133
```shell
146
134
$ npm run dev
147
135
```
148
136
149
-
Open [localhost:8000](http://localhost:8000/)
150
-
151
-
If running separate sessions is preferred, please run the following commands in individual terminal shells.
The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run `npm run build:api` to generate the doc and commit to version control.
Automated tests are required for every Auro component. See `.\test\auro-skeleton.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.
Bundled assets are only generated in the remote and not merged back to this repo. To review and/or test a bundled asset locally, run `$ npm run bundler` to generate assets.
Automated tests are required for every Auro component. See `.\test\auro-skeleton.test.js` for the tests for this component. Run `npm run test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.
0 commit comments