Nutrient Android SDK Catalog

This is the official example Catalog app for Nutrient Android SDK.

Prerequisites

• The latest stable version of Android Studio.
• A working Android emulator or a physical device.

Getting started

Follow the steps below to clone, open, and run the Catalog app locally.

1. Clone the repository

You can clone the project into any directory of your choice. Here’s an example using the ~/Downloads folder:

cd ~/Downloads
git clone https://github.com/PSPDFKit/pspdfkit-android-catalog.git
cd pspdfkit-android-catalog

2. Open in Android Studio

• Launch Android Studio.
• Select File > Open. Then navigate to and open the cloned pspdfkit-android-catalog folder.
• Wait for Gradle to sync the project.

3. Build and run

• Select the app run configuration.
• Connect a physical Android device or use an emulator.
• Click Run ‘app’ button in Android Studio.

Alternatively, you can install the app directly through the command line as demonstrated below:

./gradlew :installDebug

Video tutorial

Here’s a video tutorial that explains how to check out and build the Catalog on your machine.

License

This software is licensed under a modified BSD license.

Additional resources

• Nutrient Android SDK guides: https://nutrient.io/guides/android/current/
• Nutrient Android SDK API reference: https://nutrient.io/api/android/kdoc/
• Nutrient customer support: https://nutrient.io/support/request/