0.0.1 • Published 6 years ago
@wetrustplatform/react-ui v0.0.1
WeTrust Common UI Components and Utilities
A React library project that's used by all the WeTrust React dApps.
Setup
Node.js
- You’ll need to have Node >= 6 on your machine.
- Check the version of
node
-node -v
- Download and install the latest version here.
npm
- You also need to have npm >= 5 on your machine.
- Check the version of
npm
-npm -v
- Refer to the documentation.
npm install npm@latest -g
- Refer to this documentation to fix permission issues.
When making changes in this project, you should work with the
devtest
sub-project, so that you can check your changes before submitting and publishing your changes. Refer to the documentation on setting things up.
Development
- Get the latest codes from github.
- Go to the project directory.
cd react-ui
- Install the node modules
ornpm install
npm update
Running the build
- Start the webpack watcher
(Keep an eye on the terminal/console window, because errors are showing up there).npm start
- Enjoy coding!
Developing in Storybook
Running Storybook
yarn storybook
or
npm run storybook
and then visit
localhost:6006
Publish
- When you are done making changes, be sure to update the version number in the
package.json
. - Once your PR gets merged, the new package will be published by the build server (TBD).
- As you can see in the
package.json
file, the package name is@wetrustplatform/react-ui
.
Documentation
Libraries
- All the libraries used in all of our React apps are packaged with this module. This way, we control the library versions in one place.
- List of libraries
User Guide
- TODO - add guidelines on documentation.
- User Guide
Changelog
0.0.1
6 years ago