VersionOne UI is an open-source and community supported collection of common UI components built with React. As an open-sourced and community supported project, VersionOne UI is not formally supported by VersionOne.
Required software:
- node@^4.4.0
- tests will not work with node@7.3 or node@7.4
- npm@^3.0.0
You can run ./gulp verify to determine if you meet the above requirements. If you do not and have already attempted to run VersionOne UI, then you need to run the following commands: rm -rf node_modules docs/node_modules and npm install npm@^3.0.0 -g.
Run npm install. If there is an error, see the Prerequisites section.
This is only required to be run either the first time running VersionOne UI on your machine or if new dependencies have been added (will produce an error when running the commands below).
Run ./gulp start/docs and open your browser to http://localhost:3000.
If there is an error, try running npm install again.
Run ./gulp start and open your browser to http://localhost:9001.
If there is an error, try running npm install again.
-
Optionally use WallabyJS
-
./gulp testwill run all tests -
./gulp lintwill lint all src and test files -
./gulp test/srcwill run all VersionOne UI src tests (excluding tests frompackages/*) -
./gulp test/iconswill run all tests for icon builder package -
./gulp lint/srcwill lint src files in VersionOne UI src -
./gulp lint/testwill lint all test files in VersionOne UI src
Do NOT simply use npm publish.
- Ensure you are logged in as versionone in the NPM CLI.
- Run
./gulp publish -t {version}where {version} is one of (patch | minor | major | next)- see the Semantic Versioning docs for more info between the version types
- the docs site will automatically be deployed on major and minor releases
- manual publish of docs:
./gulp publish/docs
- manual publish of docs:
LICENSE.md - License for source code and redistribution