react-widget-library-starter

0.0.2 • Public • Published

React Widget Library


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


Getting started

  1. Install the dependencies
    • Run npm install or npm i
  2. Build the library
  • Run npm run build to produce minified version.
  1. Development mode
  • Run npm run dev to generate a non-minified library and a watcher to get compilation on file change.
  1. Run the server
  • To view in a browser or run tests, start a local server npm run server then go to localhost:3030
  1. 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

Dependencies (3)

Dev Dependencies (11)

Package Sidebar

Install

npm i react-widget-library-starter

Weekly Downloads

3

Version

0.0.2

License

none

Unpacked Size

3.75 MB

Total Files

17

Last publish

Collaborators

  • dmusiels