disprzcomponents

Introduction

ES6 react components build to use in various applications

Getting Started

To use disprz components in the application first set the npm registry to disprznpm.disprz.com.

npm set registry http://disprznpm.disprz.com:8081

or you can install it directly like this

npm install disprzcomponents --registry http://disprznpm.disprz.com:8081

Install

Stable version

npm install disprzcomponents --save

Next version

npm install disprzcomponents@next --save

Beta version

npm install disprzcomponents@beta --save

Usages

Include CSS in your App.js

import "disprzcomponents/build/index.css"

Other usages are available in Docs section of the Storybook

Contributing

Running the library

1. Run npm start
2. Run npm run example in a separate terminal
3. Modify/Add your component code inside the src folder
4. Export your component in index.js
5. Import it in the example/App.js, example:

   import {YourComponent} from 'disprzcomponents'

6. Your new component should be visible in the example app

Linting

1. Install & Configure Eslint on your editor
2. Configure it execute on saving the file

Tests

Writing Unit Tests

1. Create {componentName}.test.js file in the current folder you're working on
2. Run npm run test to watch your tests
3. Then run npm run test:coverage to generate the coverage report, make sure you reached 90% for the tests you wrote
4. Commit your changes jest-test-results.json to view your test results in Storybook

Writing Visual Tests

1. Create {componentName}.e2e.test.js file in the current folder you're working on
2. Run npm run test:e2e to watch your tests

Commit your Changes

1. Make sure you all the tests have passed before committing your changes or you won't be able to commit your changes

Deploying components

1. Run npm version followed by (one of patch, minor, major, prepatch, preminor, premajor, prerelease)
2. Followed by commit message using -m "message"
3. All your changes will be pushed under beta tag

Example

npm version prepatch -m "bug fixes for DatePicker"