Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/capacitor-community/appcenter-sdk-capacitor

Capacitor Plugin for Microsoft's Visual Studio App Center SDK.
https://github.com/capacitor-community/appcenter-sdk-capacitor

appcenter capacitor capacitor-plugin visual-studio-app-center

Last synced: about 1 month ago
JSON representation

Capacitor Plugin for Microsoft's Visual Studio App Center SDK.

Host: GitHub
URL: https://github.com/capacitor-community/appcenter-sdk-capacitor
Owner: capacitor-community
License: mit
Created: 2021-02-09T21:06:25.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-04-27T14:33:36.000Z (8 months ago)
Last Synced: 2024-10-13T13:38:32.531Z (2 months ago)
Topics: appcenter, capacitor, capacitor-plugin, visual-studio-app-center
Language: TypeScript
Homepage: https://docs.microsoft.com/en-us/appcenter/
Size: 31.1 MB
Stars: 35
Watchers: 4
Forks: 6
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-capacitorjs - @capacitor-community/appcenter-sdk-capacitor - Capacitor Plugin for Microsoft's Visual Studio App Center SDK. (Plugins / Community Plugins)

README

        # App Center SDK for Capacitor

 

 [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)

 


  

App Center is mission control for mobile apps. Get faster release cycles, higher-quality apps, and the insights to build what users want.

## Plugins

The Capacitor App Center SDK consists of a several plugins so you can use any or all of the supported App Center services. This SDK uses a modular approach, where you just add the modules for App Center services that you want to use. `appcenter-analytics` and `appcenter-crashes` make sense to add to almost every app, as they provide value with no additional setup required. `appcenter` provides general purpose App Center APIs, useful for multiple services.

| Package | Source | Version | Downloads |

| --- | --- | --- | --- |

| `@capacitor-community/appcenter` | [`./appcenter`](https://github.com/capacitor-community/appcenter-sdk-capacitor/tree/master/appcenter) | [![npm badge](https://img.shields.io/npm/v/@capacitor-community/appcenter?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/appcenter) | [![npm badge](https://img.shields.io/npm/dw/@capacitor-community/appcenter?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/appcenter)

| `@capacitor-community/appcenter-analytics` | [`./appcenter-analytics`](https://github.com/capacitor-community/appcenter-sdk-capacitor/tree/master/appcenter-analytics) | [![npm badge](https://img.shields.io/npm/v/@capacitor-community/appcenter-analytics?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/appcenter-analytics) | [![npm badge](https://img.shields.io/npm/dw/@capacitor-community/appcenter-analytics?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/appcenter-analytics)

| `@capacitor-community/appcenter-crashes` | [`./appcenter-crashes`](https://github.com/capacitor-community/appcenter-sdk-capacitor/tree/master/appcenter-crashes) | [![npm badge](https://img.shields.io/npm/v/@capacitor-community/appcenter-crashes?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/appcenter-crashes) | [![npm badge](https://img.shields.io/npm/dw/@capacitor-community/appcenter-crashes?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/appcenter-crashes)

## 📱 Example Mobile App

You can get familiar with SDK quickly by cloning this repository and running the sample app in `example` directory. For further instructions please refer to [example's README](example/README.md)

## 1. 📦 Installation

Add the App Center plugin(s) that fit your needs directly from the CLI:

```bash

npm i @capacitor-community/appcenter @capacitor-community/appcenter-analytics @capacitor-community/appcenter-crashes --save-exact

npx cap sync

```

## 2. 🛠 Configure the SDK

You must configure the project with your App Center project app secret before you can use the App Center SDK in your Capacitor project. There are other values that can also be added, but they are optional.

> Notice that it's likely that Android and iOS platforms will be associated with different applications on App Center portal so you would need to add the APP_SECRET twice - one for Android and another for iOS.

### iOS

Create a new file with the name `AppCenter-Config.plist` with the following content and replace `{APP_SECRET_VALUE}` with your app secret value. Don't forget to add this file to the Xcode project (right-click the app in Xcode and click Add files to ...).

Example:

```xml

    AppSecret

    {APP_SECRET_VALUE}

    

    LogLevel

    2

    AnalyticsEnableInJs

    

    AnalyticsTransmissionInterval

    3

    CrashesEnableInJs

    

    CrashesAlwaysSend

    

```

### Android

Create a new file with the name `appcenter-config.json` in `android/app/src/main/assets/` with the following content and replace {APP_SECRET_VALUE} with your app secret value.

```json

{

    "app_secret": "{APP_SECRET_VALUE}",

    "start_automatically": true

}

```

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{John Borges}
💻

    
_{Hrafnkell Baldursson}
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!