Getting started with Insiders¶

In order to access our Sponsorware, you need to become an eligible sponsor of Capawesome on Polar. As soon as you've completed the sponsorship, you can immediately retrieve your license key by following these steps.

Installation¶

Follow these steps to install the private packages:

Configure the Capawesome npm registry:

npm config set @capawesome-team:registry https://npm.registry.capawesome.io
npm config set //npm.registry.capawesome.io/:_authToken <YOUR_LICENSE_KEY>

Attention: Replace <YOUR_LICENSE_KEY> with the license key you received from Polar.

Install the plugin:

npm install @capawesome-team/<plugin-name>
npx cap sync

CI/CD Configuration¶

Follow the steps in this section to configure your CI/CD environment to install the private packages.

GitHub Actions¶

Follow these steps if you are using GitHub Actions as your CI/CD environment:

Get the license key and add it to your repository as an encrypted secret with the name CAPAWESOME_TOKEN as described in Creating encrypted secrets for a repository

Add the following step to your GitHub Actions workflow before installing the npm dependencies:

- name: Configure the Capawesome npm registry
  run: |
    echo "@capawesome-team:registry=https://npm.registry.capawesome.io" >> .npmrc
    echo "//npm.registry.capawesome.io/:_authToken=${{ secrets.CAPAWESOME_TOKEN }}" >> .npmrc

Ionic Appflow¶

Follow these steps if you are using Ionic Appflow as your CI/CD environment:

Get the license key and add it to your Ionic Appflow environment as an encrypted secret with the name CAPAWESOME_TOKEN as described in Using private npm modules

Create a new file named .npmrc in the root of your project and add the following content:

@capawesome-team:registry=https://npm.registry.capawesome.io
//npm.registry.capawesome.io/:_authToken=${CAPAWESOME_TOKEN}