HealthShare Personal Community Mobile Application Guide
Document Controls
Personal Community Version | Date of Last Update | Version | Status |
---|---|---|---|
2024.5 |
Friday, September 13, 2024 |
eg. 1.0
|
Commenced |
Personal Community is designed as a fully responsive web application. Additionally, organizations can deploy Personal Community as a mobile application available on various app stores.
This guide outlines how to leverage the mobile application framework to build and deploy the hybrid mobile application. Hybrid mobile apps are developed using web technologies such as HTML, CSS, and JavaScript but are wrapped in a native container, allowing them to be installed on mobile devices and accessed through app stores.
Personal Community uses Capacitor to create the hybrid mobile application.
Capacitor is a cross-platform app runtime that provides a native bridge for web apps, enabling you to build and deploy mobile applications using web technologies. Capacitor allows you to:
To learn more about Capacitor, visit the
official Capacitor documentation
.
Ownership of the mobile application is shared across three parties:
Version Dependencies
Building the mobile application for Personal Community requires specific versions of software. Always ensure you are using the versions specified in this document, failure to due so may cause unexpected behavior in the application.
If you are building the application for iOS, your environment must be
macOS
.
Ensure you are using the correct version of NodeJS for the version of Personal Community you are using.
Use the following steps to install:
Building the mobile app for iOS requires macOS.
Install the following dependencies:
Xcode is Apple's IDE for creating native macOS, iOS, and iPadOS applications. Install Xcode by using the Apple App Store on your Mac.
The Xcode command line tools are additional tools not included with the core of Xcode that are required for building and testing our application. Once Xcode has been installed, install the Xcode Command Line Tools by running the following command in the terminal:
V
erify that the tools are installed.
Homebrew is a package manager for macOS packages. We need to install it in order to install CocoaPods. To install Homebrew, run the following bash command:
Cocoapods is an iOS dependency manager that Capacitor uses to install and manage native dependencies for the iOS project. We can install
CocoaPods
by running the following command in the terminal:
V
erify that CocoaPods has installed correctly by running the following command
:
Install the following dependencies to build the mobile application for Android:
Android Studio
An Android SDK installation
Personal Community makes a pre-configured repository available for creating the mobile application. Contact the WRC to receive the repository and ReadMe file for installation.
Follow the steps in the ReadMe file to complete the following:
For patients to be able to download and install the Personal Community mobile application, it must be published to an app store. InterSystems has verified the process for publishing to Apple and Google Play. Implementation should review the full documentation provided by each app store the customer wishes to publish with.
Prior to building the application for release, the following information will be needed:
Publishing to the app store requires designing and providing the information needed to create a store listing. This includes:
Both Apple and Google require a set of attestations and privacy policies in order to publish the application. Implementation should review what is needed for the desired stores and ensure the customer provides the appropriate links and materials well in advance of publishing. This includes, but is not limited to:
Both Apple and Google walk the user through completing all the information needed to publish the app to their store.
The following steps are run within Xcode to build, sign, and publish the application.
In Xcode, navigate to the General setting. In Identity, set the following:
Select the Info file in your App project. On the Information Property List, set the following:
These steps assume you have created the appropriate assets catalog for your app icon.
From Xcode:
In XCode, run the following to publish the app to App Connect
From App Connect, you can now see this build of the application and can initiate testing, the review process, or publishing.
The Google Play Console will only take apps that meet the following requirements:
In Visual Studio we will set the name and the version of the app.
In Android Studio, navigate to your app/res directory. To add icons:
In Android Studio:
Once you've built your bundle you can upload to the Google Play Console for internal, closed, open testing, and to publish for release.
1.
Overview
2.
Responsibility Matrix
3.
Building the Personal Community Mobile Application with Capacitor
3.1.
Environment Requirements
3.2.
Installing NodeJS
Personal Community Version
Node Version
npm Version
2024.5
16.19.0
8.19.3
nvm install 16.19.0
nvm use 16.19.0
nvm alias default 16.19.0
node --version
# v16.19.0
npm --version
# v8.19.3
npm install -g npm@8.19.3
nvm\[node version]
folder (e.g. C:\Users\[user name]\AppData\Roaming\nvm\10.15.1)
C:\Users\[user name]\AppData\Roaming\nvm\[node version]\npm
C:\Users\[user name]\AppData\Roaming\nvm\[node version]\npm.cmd
C:\Users\[user name]\AppData\Roaming\nvm\[node version]\npx
C:\Users\[user name]\AppData\Roaming\nvm\[node version]\npx.cmd
C:\Users\[user name]\AppData\Roaming\nvm\[node version]\node_modules\npm2
cd C:\Users\[user name]\AppData\Roaming\nvm\[node version]\node_modules\npm2\bin
node npm-cli.js i -g npm@8.19.3
npm --version
# v8.19.3
3.3.
Requirements for iOS
3.3.1.
Xcode
3.3.2.
XCode Command Line Tools
xcode-select --install
xcode-select -p
# /Applications/Xcode.app/Contents/Developer
3.3.3.
Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
3.3.4.
Cocoapods
brew install cocoapods
pod --version
# 1.12.1
3.4.
Requirements for Android
3.5.
Installing Base-Capacitor-Env
4.
Publishing the App
4.1.
Required Information Needed
4.1.1.
Application Items Need Prior to Building a Release
4.1.2.
Marketing Materials
4.1.3.
Privacy and Security Materials
4.2.
Building the App for Apple Distribution
4.2.1.
Setting the Application Name and Version in Xcode
4.2.2.
Setting your App Icons
4.2.3.
Publishing the App to App Connect
4.3.
Building the App for Android Distribution
4.3.1.
Setting the Application Name and Version
4.3.2.
Setting your App Icons
4.3.3.
Building and Signing the App
4.3.4.
Google Play Console