1.2.1 • Published 2 years ago
@keen.io/pubsub v1.2.1
Keen
The Complete Event Data Management Solution
This project contains mono-repository for Keen.io Front-End projects and applications.
Documentation
All documentation, including charts, widgets and dataviz can be found at Storybook
Contribution guide
This is an open source project and we love involvement from the community! Hit us up with pull requests and issues.
Project structure
.
├── ...
├── packages
│ ├── charts
│ ├── widgets
│ ├── dataviz
│ ├── parser
│ ├── ui-core
│ ├── colors
│ ├── embedded-registration
│ ├── tracking-lite
│ └── storybook-utils
└── ...npm scripts
List of useful commands that could be used by developers. Execution in the command-line interface should be prefixed with yarn package manager.
| Command | Description |
|---|---|
storybook | run storybook for development on port 3000 |
build-storybook | build storybook production distribution. |
lint | run linter against current application codebase. |
test | run unit tests. |
test:cov | run unit tests with coverage reporter. |
prettier | run code formatter process against current codebase. |
commit
This project uses Conventional Commits to enforce common commit standards.
| Command | Description |
|---|---|
npx git-cz | run commit command line interface. |
build packages
| Command | Description |
|---|---|
npx lerna run build | run build script from package.json for each package |
add dependency to package
| Command | Description |
|---|---|
npx lerna add <name>[@ver] packages/<name> [--dev] | Add dependency to specific package in mono-repository. |
updating dependencies
| Command | Description |
|---|---|
update-packages | run update wizard command line interface. |
deployments
The all commits pushed into master branch will be picked by CircleCI workflow that perform npm packages version and publish.