Indigo UI library, its CSS and React components. Also Styleguide app showing usages of this library.
- Make sure you have Node 14 installed
- Install grunt:
yarn global add grunt-cli
- Install dependencies:
- Run storybook
- Open browser at http://localhost:9009/
Dockerfileto check what's inside)
- Run container:
docker-compose run --rm --service-ports node
- Continue from step 3. (including) in section above (
yarn dev, ...)
yarn dev: Start Storybook server
yarn test: Run tests
yarn build-lib: Build package prepared for publishing to npmjs registry
yarn build-storybook: Prepare Storybook for deployment
yarn stylelint: Check less files for errors
Creating new React Component
- Create new component file in
- Add tests (if needed) and snapshots for new component (e.g.
- Add new component to main file
src/indigo/components/index.jsto enable its export.
Check local build of
Make sure you have package prepared
yarn link (preferred)
yarn link "@keboola/indigo-ui"
Similar (but reversed) process applies for
yarn add file:/path/to/indigo-ui
Simultaneously with Keboola Connection (Advanced, Docker only)
First, check the content of
.travis.yml file and documentation about
- Storybook is deployed on every push to
"$TRAVIS_BRANCH" = "master"condition in
deploy-storybook.shscript is responsible for deploying. Basically, it's a "home made" replacement for Travis
deploysection, since that section is used for something else (covered bellow).
- After successful deployment, the Storybook build will be available online
Releasing new version
- Before pushing new tag, make sure you know what are you doing.
- New tagged release is only needed if there's a change in
src/indigofolder and you want to make those changes available for users.
- Please respect Semantic versioning
- Make sure everything is working as expected
- Prepare new version with
yarn versioncommand. Just follow instructions. This command should create new commit (with version change in
package.json) and tag for you. There's no need to change
package.jsonmanually or create tag manually.
- Push to
masterbranch - e.g
git push origin master
- Check if everything is as expected
- Push newly created tag - e.g.
git push origin v2.0.0-beta-3<- This triggers deploy to npmjs!
- Check package in npmjs registry, try to install it or update to newer version from some project
- Write release notes keboola/indigo-ui/releases
How to run tests?
yarn test. It'll start tests in interactive mode.
How to check what will be published to npmjs registry before pushing new tag?
npm pack. Check its manual here.
How to check react-bootstrap documentation at specific version
If published version does not match installed version.
git clone email@example.com:react-bootstrap/react-bootstrap.git cd react-bootstrap git fetch --all git checkout v0.31.5 # use version you need npm run docs
Open browser at