Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 1.93 KB

README.md

File metadata and controls

48 lines (29 loc) · 1.93 KB
Raw

Spresso Web Event SDK

Installation

See the docs for more info.

Development

npm run dev bundles and serves the SDK on: http://localhost:3002/spresso.sdk.tracking.web.js.

npm run dev:prod-mode does the same but as if NODE_ENV === 'production', i.e., no sourcemap and logging in browser console.

Developer workflow

  • Create branch from main into feature/SPRS-XXXX.
  • Test locally on webapp by changing the script src in components/misc/spresso-web-sdk to:
http://localhost:3002/spresso.sdk.tracking.web.js

Updating docs

  • npm run docs will build the docs locally in watch mode.
  • Open ./docs/index.html in your browser.

Build and deploy

Staging

  • PR feature branch to staging.
  • Push/merge to staging branch to build/upload script to staging Spresso GCP bucket, nested under the folder named the last commit hash pushed to staging.

Production

  • Update the version in package.json.
  • PR staging branch to main.
  • Push/merge to main branch will NOT build/upload script.
  • Create a new release tag (must equal the package.json version) on main to build/upload script to production Spresso GCP bucket, nested under the folder named the release version.
  • A new release tag will also re-publish the docs.

Author

Spresso, [email protected]

License

Spresso Web Event SDK is available under the MIT license. See the LICENSE file for more info.