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 have completed the sponsorship, you will will automatically receive a unique license key, giving you access to the Capawesome npm registry.
Requirements¶
To be able to install the private packages, you need to get your license key from Polar. This key is used to authenticate against the Capawesome npm registry. Follow these steps to get your license key:
-
Navigate to the Subscriptions page on Polar, search for
Capawesome
and click onView Benefits
. -
Copy the license key from the
Benefits
section.
Now you can use this license key to install the private packages.
Warning
Keep your license key secret and do not share it with others. If you have any questions, please let us know. Follow the instructions in CI/CD Configuration to securely configure your CI/CD environment.
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:
That's it! Have fun using the Sponsorware.
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:
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: