onymos-logo
starter icon

Quickstart Guide: Starter App

Starter App

Select a framework to get started.

Get started

Get the Starter app up and running in four easy steps.

  1. Download the Starter Bundle
  2. Build the environment
  3. Build the app
  4. Troubleshoot

1. Download the Starter App

Sign up! We’ll send you a link to your Starter app, set up your Onymos Cloud Account, and generate your Onymos license credentials. In the meantime, you can get familiar with our API Documentation and developer resources, or join a whole community of developers building apps with Onymos on Reddit!

2. Build the environment

If you’re new to building Ionic and Cordova mobile apps (or mobile apps in general), check out our guide on how to set up your development environment. We’ll tell you what you need and, maybe more importantly, why you need it!

3. Build the app

Getting started
Get started by creating an empty directory and adding your Stater app. In this guide, we’ll refer to it as ‘myApp,’ but you can call it anything you want—it’s yours! 

Adding your Onymos license credentials
All signed-up? You should have received your Onymos license credentials: a Customer ID, an Onymos Auth Token, and a Widget ID. Add your Customer ID and Onymos Auth Token to the onymosConnectObject inside of the onymos-config.ts file, then add your Widget ID to the widget inside of the config.xml file. In addition to your Onymos license credentials, you should have also received an IOS_URL_SCHEME value to include with your Access component in the addPlugins.bat file (for PC) and the addPlugins.sh file (for Mac).

Installing node packages  
Run the following command in the root of ‘myApp’ to install the required Node packages.

$ npm install 

Building the Starter app for iOS  
On Mac? Follow these instructions to build the Starter app for iOS devices.

Installing the iOS platform  
Run the following command in the root of ‘myApp’ to install the iOS platform.

$ ionic cordova platform add ios@latest

Installing the Onymos components
Run the the addPlugins.sh file in the root of ‘myApp’ to install the Onymos components.

Setting up Xcode
First, open Xcode, then open your xcworkspace file from this directory:

myApp/platforms/ios/yourAppName.xcworkspace

In the ‘Signing & Capabilities’ section:

  • Choose a team from your Apple Development accounts. There may be additional sections where you select this team.
  • Add ‘Push Notifications,’ ‘Sign In with Apple,’ and ‘Associated Domains’ as capabilities. Add the Associated Domain provided by Onymos to the ‘Domains’ sub-section (e.g., “applinks:example.page.link”).
  • In the ‘Build Settings’ section, under ‘Signing’ > ‘Code Signing Identity,’ ensure that both the ‘Debug’ and ‘Release’ selections are currently set to ‘iOS Developer.’
  • In the ‘Build Phases’ section, ensure there are no entries under ‘Output Files.’ If there are, remove them by clicking on the ‘—’ button at the bottom-left of that section.

Build and test  
Run the following command in the root of ‘myApp’ to build the Starter app. 

$ ionic cordova build iOS

Congratulations! You’ve built your first iOS app with Onymos. Now you’ll have to test it. Follow these instructions in Xcode’s official documentation to install the Starter app on a simulator or a connected device. 

Building the Starter app for Android  
On PC or Mac? Follow these instructions to build the Starter app for Android devices. 

Installing the Android platform  
Run the following command in the root of ‘myApp’ to install the Android platform.

$ ionic cordova platform add android@latest

Installing the Onymos components  
Run the addPlugins file in the root of ‘myApp’ to install the Onymos components.

Build and test  
Run the following command in the root of ‘myApp’ to build the Starter app. 

$ ionic cordova build android

Congratulations! You’ve built your first Android app with Onymos. Now you’ll have to test it. Run the following command in the root of ‘myApp’ to install the Starter app on a simulator or a connected device.  

$ ionic cordova run android

Have friends and family on Android devices? Share it with them! They can click on the app-debug.apk file to install it. This Development APK can be found at:

myApp/platforms/android/app/build/outputs/apk/debug/app-debug.apk

4. Troubleshooting

How do I squash this bug? Is Ionic supposed to do that? Why is this iOS build failing?

Let’s figure it out—join the Onymos community on Reddit! More of a loner? You can email us directly at customersuccess@onymos.com.

Dig into our API documentation

Developer support

Got questions? Our support team is here to help.

Think differently about app development

Download our free white paper today to learn how Onymos Features can maximize the value of your developer resources — and shave days or weeks off your schedule.

Get your free white paper