@igloosoftware/web-sdk v0.1.122
Web SDK
A front end SDK for integration with Igloo apps and widgets
Table of Contents
About The Project
The Web SDK project is designed as an NPM package that can be imported into any of the various apps and widgets of Igloo. It provides common methods and functionality such as user auth, making API calls, snackbar notifications, etc.
Built With
Getting Started
To set up the project locally for development:
- Clone the repo
git clone https://github.com/igloosoftware/web-sdk.git
- Install NPM packages
npm install
Usage
To use the sdk in your Igloo apps and widgets, run the following in your project folder:
npm i @igloosoftware/web-sdk
You can then import any required methods into your project as usual:
import { getAuthInfo, useSnackbar } from "@igloosoftware/web-sdk";
Publishing
To publish a new version of the project, you will first need to configure npm and login to your account:
- If you do not have an account at npmjs.com, register a new one and set up 2 factor authentication (see the npmjs docs for instructions).
- After registering, you will need to request an admin to grant you access to npmjs @igloosoftware
- Login to your account on the command line using
npm login
- Ensure the correct registry is set in your config file. Run
npm config list
to see your current settings or runnpm config set registry="https://registry.npmjs.org/"
to set your registry if needed. - In the package.json file in the web-sdk project folder, increment the package
version in order to publish a new version to npm. For example,
"version": "0.1.45"
becomes"version": "0.1.46"
for a patch update. Make sure you rannpm i
after changing the version. - Make sure you checked out to a new feature branch in the project folder, then
run
npm run build
- Still in the project folder, run
npm run publish
. You should get an email from npm shortly to confirm that a new version was successfully published. Please note that it is likely that while runningnpm run publish
you will likely get a warning and a couple of errors in the console. As long as you got a publish confirmation error - ignore them. Also you can go to npm site and check is your version is up. - Once testing is complete, create a PR.
- Once PR is merged - create another PR for the
web
repo and bump@igloosoftware/web-sdk
version inpackage.json
file to match the one you deployed. Do not forget to runnpm i
before pushing your version changes.
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago