RAVEN SDK WEB
This SDK allows developers to seamlessly integrate Raven into their Web applications
Commands
Install dependencies
To install the dependencies run:
npm i
To do a one-off build
npm run build
This builds the library to /dist
folder
To run in watch mode run
npm start
This builds to /dist
and runs the project in watch mode so any edits you save inside src
causes a rebuild to /dist
.
To run tests run
npm run test
Checking if it's working
To use this package in another app you will need to link it
To do so, go into the SDK folder and run
npm link
then inside of the folder of the app you want to check it in run
npm link raven-sdk-web
Bundle Analysis
size-limit
is set up to calculate the real cost of your library with npm run size
and visualize the bundle with npm run analyze
.
Module Formats
CJS, ESModules, and UMD module formats are supported.
The appropriate paths are configured in package.json
and dist/index.js
accordingly.
Named Exports
Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.
Including Styles
There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
For vanilla CSS, you can include it at the root directory and add it to the files
section in your package.json
, so that it can be imported separately by your users and run through their bundler's loader.