|
1 | | -# react-modern-library-boilerplate |
| 1 | +# react-web-worker |
2 | 2 |
|
3 | | -> Boilerplate and CLI [create-react-library](https://github.com/transitive-bullshit/create-react-library) for publishing modern React modules with Rollup and example usage via create-react-app. |
4 | | -
|
5 | | -[](https://www.npmjs.com/package/react-modern-library-boilerplate) [](https://standardjs.com) |
| 3 | +> A Simple Library to use web worker with your React Application Easily |
6 | 4 |
|
7 | 5 | ## Intro |
8 | 6 |
|
9 | | -*Note*: Modern means modern as of March, 2018.. I'm sure everything will change in a month... :joy: :joy: |
10 | | - |
11 | | -We strongly recommend that you use the accompanying CLI [create-react-library](https://github.com/transitive-bullshit/create-react-library) to create new modules based off of this boilerplate. |
12 | | - |
13 | | -**The purpose of this boilerplate is to make publishing your own React components as simple as possible.** |
| 7 | +If you are using some expensive processes inside your webpage, make sure you don't compromise your performance there. Web workers can make your web page feel smooth and realistic |
14 | 8 |
|
15 | 9 | ## Features |
16 | 10 |
|
17 | | -- Easy-to-use CLI [create-react-library](https://github.com/transitive-bullshit/create-react-library) |
18 | | -- Transpiles all modern JS features |
19 | | -- Bundles `cjs` and `es` module formats |
20 | | -- [create-react-app](https://github.com/facebookincubator/create-react-app) for example usage and local dev |
21 | | -- [Rollup](https://rollupjs.org/) for build process |
22 | | -- [Babel](https://babeljs.io/) for transpilation |
23 | | -- [Jest](https://facebook.github.io/jest/) for testing |
24 | | -- Supports complicated peer-dependencies |
25 | | -- Supports CSS modules |
26 | | -- Sourcemap creation |
27 | | -- Thorough documentation :heart_eyes: |
28 | | - |
29 | | -## Manual Setup |
30 | | - |
31 | | -If you'd prefer to setup a new module manually, check out the introductory [blog post](https://hackernoon.com/publishing-baller-react-modules-2b039d84bce7) and the old [manual guide](https://github.com/transitive-bullshit/react-modern-library-boilerplate/blob/master/manual.md). |
| 11 | +- Simple to Use |
| 12 | +- Just import and start using |
| 13 | +- All the default functionality is kept |
| 14 | +- Create your worker function and export it |
32 | 15 |
|
33 | 16 | ## Examples |
34 | 17 |
|
35 | | -Here is an example react module created from this boilerplate: [react-background-slideshow](https://github.com/transitive-bullshit/react-background-slideshow), a sexy tiled background slideshow for React. It comes with an example create-react-app hosted on github pages. |
36 | | - |
37 | | -### Multiple Named Exports |
38 | | - |
39 | | -Here is a [branch](https://github.com/transitive-bullshit/react-modern-library-boilerplate/tree/feature/multiple-exports) which demonstrates how to create a module with multiple named exports. The module in this branch exports two components, `Foo` and `Bar`, and shows how to use them from the example app. |
40 | | - |
41 | | -### Material-UI |
42 | | - |
43 | | -Here is a [branch](https://github.com/transitive-bullshit/react-modern-library-boilerplate/tree/feature/material-ui) which demonstrates how to create a module that makes use of a relatively complicated peer dependency, [material-ui](https://github.com/mui-org/material-ui). It shows the power of [rollup-plugin-peer-deps-external](https://www.npmjs.com/package/rollup-plugin-peer-deps-external) which makes it a breeze to create reusable modules that include complicated material-ui subcomponents without having them bundled as a part of your module. |
| 18 | +- Here's an Example of this library [Example](https://github.com/https://github.com/zonayedpca/react-web-worker/tree/master/example) |
| 19 | +- Here's an Example of web worker in Action [Web Worker in Action](https://github.com/zonayedpca/web-workers) |
44 | 20 |
|
45 | 21 | ## License |
46 | 22 |
|
47 | | -MIT © [Travis Fischer](https://github.com/transitive-bullshit) |
| 23 | +MIT © [Zonayed Ahmed](https://github.com/zonayedpca) |
0 commit comments