1.0.1 • Published 5 years ago
indra-design-system v1.0.1
To add to your project:
# this will add the latest official release
yarn add indra-design-systemTo use an older version, add pin the npm version you want to your package.json dependencies:
...
"dependencies": {
"indra-design-system": "^0.0.0"
}
...To generate static asset files to use in a stand-alone HTML doc, run this command:
yarn build:staticThen use <script/> and <link/> tags to include to the js and css files in the static/system directory in your HTML. Then include any indra components in a wrapper with class="indra".
To contribute to indra:
- You will need Node v10.16.0+
- If you use a NVM, run
nvm installornvm useif you already know you have Node v10.16.0
yarn installTo start development server:
yarn startTo run all unit tests:
yarn testTo run a single test:
yarn unit mytest.spec.jsTo develop indra locally as a dependency in a project
You might want to develop indra while developing on a project that uses indra as a dependency. For example, you might want to develop indra components while developing the Approvals app. NOTE: You will need to have both indra and the project using it as a dependency running on your machine.
- Install yalc
- In the indra root directory, run
yarn build:system && yalc publish - In the Project (e.g., Approvals) root directory, run
yalc add indra-design-system - Each time that you are ready to view the indra work in progress, run the last 2 steps:
- In the indra root directory, run
yarn build:system && yalc publish - In the Project (e.g., Approvals) root directory, run
yalc update
- In the indra root directory, run
To deploy docs:
# make sure git status is clean with no uncommitted modified files
yarn run deployTo publish a new version to npm:
- Pull latest master with merged changes.
- Run
yarn release - :tada: