wg-fe-ui
v2.2.1
Published
> An React based Front-end platform containing a few broker tools.
Downloads
53
Readme
Table of Contents
About
React implementation of the WeGroup Design System.
Development
in the root of the project run:
- Install packages
$ npm i
- run storybook.
$ npm run storybook
Contributing
Pull request
The project uses 2 main braches, master and dev. To contribute please open an pull-request from you current branch feature/ or bug/ to dev.
Adding a dependency
When you want to use an additional package, you need to install it via npm install or npm install --dev (if its an development dependency)
Code style and CI
Eslint
We use Eslint to lint syntax and code logic errors
We use:
Prettier
Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.
Testing
Running tests automatically
This project makes usage of jest and enzyme which automatically creates a virtual environment and launches all the unit tests.
Run from the root of the repository
$ npm run test:watch
Built Using
- React - JavaScript library for building user interfaces
- Webpack - A bundler for javascript and friends
- styled-components - Visual primitives for the component age.
- storybook - UI component dev & test: React, Vue, Angular, React Native, Ember, Web Components & more!