0.1.10 • Published 14 days ago
@eyepop.ai/javascript-sdk v0.1.10
Usage in a project
- Because this is a private package, make sure you have an
.npmrc
in the root of the project with the following line://registry.npmjs.org/:_authToken=${EYEPOP_NPM_TOKEN}
. WhereEYEPOP_NPM_TOKEN
is either an env var exported in your shell (e.g.export EYEPOP_NPM_TOKEN=<token>
) or pasted directly into the file. Please note: The.npmrc
file could be in version control. Make sure you don't commit your token! - In the project you'd like to install the package, run
npm install @eyepop.ai/javascript-sdk
- Import into your project
import EyePopSDK from '@eyepop.ai/javascript-sdk'
Development
Using npm as package manager
- Install development dependencies:
npm install
- Build the module:
npm run build
- Clean the dist folder:
npm run clean
- Clean and then build:
npm run build:clean
- Link a local client to the project:
npm link ../<project>
. This will add a linked folder to that projects' node_modules. You won't see it in yourpackage.json
- Run the example page to test your changes live:
npm run dev
- Start the compiler in watch mode only. It will hot reload on changes:
npm run watch
- See
package.json
for other helpful scripts.
Publishing a new version
- Login to npm with
npm login
- Tag the release and update the
version
property of yourpackage.json
. i.e:
...
{
"version": "1.0.0"
}
...
becomes:
...
{
"version": "1.0.1"
}
...
Automatic publish via github actions
- Push your changes to the
main
branch - Create a new release in github. (on the right side of the repo, click
Releases
thenDraft a new release
) - Click Tags and enter the version number you want to publish. e.g.
1.0.1
(create a new tag if it doesn't exist) - Click Publish release
- Github actions will automatically build and publish the package to npm
Manual publish
- Commit your changes and publish to the npm registry with
npm publish
- Optionally, you might add a beta tag with the option
npm publish --tag beta
This will append-beta
to the version number. e.g.:1.0.1-beta
- By default, a consumer of this library will always pull the the latest published version regardless of the tag when
running
npm install
. You might have occasion to work with multiple tags. In that case, you can specify the tag when installing the package. e.g.npm install @eyepop.ai/javascript-sdk1.0.1-@beta
- See the notes about semantic versioning below
Links
0.1.10
14 days ago
0.1.8
2 months ago
0.1.9
2 months ago
0.1.7
3 months ago
0.1.4
3 months ago
0.1.6
3 months ago
0.1.5
3 months ago
0.1.3
3 months ago
0.1.2
3 months ago
0.1.1
3 months ago
0.1.0
3 months ago
0.0.31
3 months ago
0.0.30
3 months ago
0.0.28
3 months ago
0.0.29
3 months ago
0.0.26
3 months ago
0.0.27
3 months ago
0.0.25
4 months ago
0.0.24
6 months ago
0.0.23
6 months ago
0.0.21
6 months ago
0.0.20
6 months ago
0.0.19
6 months ago
0.0.18
6 months ago
0.0.15
7 months ago
0.0.14
7 months ago
0.0.13
7 months ago
0.0.12
7 months ago
0.0.10
7 months ago
0.0.8
7 months ago
0.0.7
7 months ago
0.0.5
7 months ago
0.0.4
7 months ago
0.0.3
9 months ago
0.0.2
9 months ago
0.0.1
9 months ago