Getting started with Insiders¶

Welcome to Capawesome Insiders! You've joined 500+ development teams who trust our plugins to build production apps. You now have access to 17+ professional Capacitor plugins that will save you weeks of development time.

What You Get¶

As an Insider, you get immediate access to:

Full source code for all 17+ Insider plugins (1M+ downloads/month)
Complete documentation with examples and guides
Priority support from official Ionic Developer Experts (tier-dependent)
Regular updates for new OS versions and features
Breaking change support and migration guides
New plugins added every other month

Browse all available plugins

Retrieve Your License Key¶

After subscribing, your license key is displayed immediately on the checkout page. You can retrieve it anytime:

Visit the Polar Customer Portal
Log in with the email address used for your subscription
Copy your license key from the "License Keys" section

Keep your license key secure - it provides access to the private npm registry.

Quick Start¶

Get started in under 2 minutes. Follow these steps to install your first Insider plugin:

Step 1: Configure npm Registry¶

Configure npm to use the Capawesome private registry:

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

Replace the placeholder

Replace <YOUR_LICENSE_KEY> with your actual license key from the Polar Customer Portal.

Step 2: Install a Plugin¶

Install any Insider plugin using npm:

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

Example: To install the NFC plugin:

npm install @capawesome-team/capacitor-nfc
npx cap sync

Step 3: Import and Use¶

Import the plugin in your code and start using it:

import { Nfc } from '@capawesome-team/capacitor-nfc';

// Start using the plugin
const result = await Nfc.isSupported();
console.log('NFC supported:', result.isSupported);

That's it! Check each plugin's documentation for detailed API reference and examples.

What's Next?¶

Explore Plugins

Browse the complete list of available Insider plugins and their capabilities.

View all plugins
Read Documentation

Each plugin has comprehensive documentation with examples and API reference.

Plugin documentation
Get Support

Need help? Access priority support via GitHub, Discord, or Email.

Learn about support
CI/CD Setup

Set up Insider plugins in your CI/CD pipeline for automated builds.

View integrations

CI/CD Configuration¶

Using Insider plugins in your CI/CD pipeline requires configuring the private npm registry with your license key. We provide step-by-step guides for popular platforms:

GitHub Actions

Configure GitHub Actions to access Insider plugins in your workflows.

View guide
GitLab CI/CD

Set up GitLab CI/CD pipelines with Insider plugin access.

View guide
Azure DevOps

Configure Azure Pipelines for Insider plugin builds.

View guide
Bitbucket Pipelines

Enable Insider plugins in Bitbucket CI/CD.

View guide
Ionic Appflow

Use Insider plugins with Ionic's cloud build service.

View guide
Vercel

Deploy apps using Insider plugins on Vercel.

View guide
Cloudflare Pages

Build and deploy with Insider plugins on Cloudflare.

View guide
AWS Amplify

Configure AWS Amplify for Insider plugin builds.

View guide
Jenkins

Set up Jenkins pipelines with Insider plugin access.

View guide

Troubleshooting¶

Common Issues¶

Authentication failed when installing plugins:

Verify your license key is correct in the Polar Customer Portal
Ensure you've configured both npm registry settings (registry URL and auth token)
Check that your subscription is active

Plugin not found:

Make sure you're using the correct package name: @capawesome-team/<plugin-name>
Verify your license hasn't expired (for perpetual licenses)

Need more help?

Contact our support team at support@capawesome.io or visit our support page for priority assistance.