react-widget-library-starter

React Widget Library

---

React boilerplate for producing libraries of embeddable widgets. Based 99% upon work by krasimir:

• Webpack Library Starter (Webpack based boilerplate for producing libraries - Input: ES6, Output: universal library)
• Start your own JavaScript library using webpack and ES6

---

Getting started

1. Install the dependencies
   • Run npm install or npm i
2. Build the library

• Run npm run build to produce minified version.

3. Development mode

• Run npm run dev to generate a non-minified library and a watcher to get compilation on file change.

4. Run the server

• To view in a browser or run tests, start a local server npm run server then go to localhost:3030

5. Run the tests

• Run the tests in headless mode npm run test
• Run the tests through the Cypress GUI npm run cypress

Features

• Webpack-based
• ES6 as a source
• Exports in a umd format so the library works everywhere
• Testing with Cypress

Process

ES6 source files
       |
       |
    webpack
       |
       +--- babel, eslint
       |
  ready to use
     library
  in umd format

Tests

Testing with Cypress

• Docs
• Examples