Installation

This package is distributed as a private GitHub Package. Follow these steps in the host React Native app.


1) Obtain package access token from integration owner

Request a GitHub Packages access token from the KLP team.

2) Expose token as an environment variable

Do not hardcode tokens in source files.

export GITHUB_TOKEN=YOUR_GITHUB_TOKEN

If you use zsh, add the same line to ~/.zshrc for local persistence.

3) Configure .npmrc in project root (required)

Create/update .npmrc in the host app root directory (same level as package.json):

@kaizen-dev-team:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

Example structure:

my-rn-app/
  .npmrc
  package.json
  ios/
  android/

Do not place this configuration in app source files. Project-root .npmrc is used during npm install.

4) Install package

npm install @kaizen-dev-team/rn-sdk @kaizen-dev-team/nebula-sdk

5) iOS only: install CocoaPods

cd ios && pod install

6) CI/CD setup

In CI, store GITHUB_TOKEN as a secret and inject it at runtime. Keep .npmrc with ${GITHUB_TOKEN} placeholder only.

Security notes

  • Never commit real tokens into .npmrc, .env, or source files
  • Never pass token values through React Native runtime config
  • Token is only needed during dependency installation, not at app runtime


Did this page help you?