Quickstart: Android App with FusionAuth Android SDK

This repository contains an Android app extracted from the FusionAuth Android SDK that works with a locally running instance of FusionAuth, the authentication and authorization platform.

Setup

Prerequisites

You will need the following things properly installed on your computer.

• Android Studio: The official IDE for Android helps you develop and install the necessary tools to set it up.
  • At least Java 17 (which you can install via Android Studio)
• Docker: The quickest way to stand up FusionAuth. Ensure you also have docker compose installed.
  • (Alternatively, you can Install FusionAuth Manually).

FusionAuth Installation via Docker

The root of this project directory (next to this README) are two files: a Docker compose file and an environment variables configuration file. Assuming you have Docker installed on your machine, you can stand up FusionAuth up on your machine with:

docker compose up -d

The FusionAuth configuration files also make use of a unique feature of FusionAuth, called Kickstart: when FusionAuth comes up for the first time, it will look at the Kickstart file and mimic API calls to configure FusionAuth for use when it is first run.

NOTE: If you ever want to reset the FusionAuth system, delete the volumes created by Docker Compose by executing docker compose down -v.

FusionAuth will be initially configured with these settings:

• Your client Id is: 21e13847-4f30-4477-a2d9-33c3a80bd15a
• Your Example Android App test user richard@example.com and your password is password.
• Your FusionAuth admin username is admin@example.com and your password is password.
• Your fusionAuthBaseUrl to access FusionAuth is http://localhost:9011/

You can log into the FusionAuth admin UI and look around if you want, but with Docker/Kickstart you don't need to.

Running the Android App

This Android Quickstart is fully functional and can be used without any modifications:

• Open this project's complete-application folder in Android Studio.
• Either connect a hardware device or create an Android Virtual Device to run the Android Emulator.
• Build and run the app following Android Studio guidelines.

And there are additional testing instructions available for different scenarios.

Further Information

Please follow the following sections for further information about the Quickstart and FusionAuth Android SDK.

Quickstart

See the FusionAuth Android Quickstart for a full tutorial on using FusionAuth and Android.

Documentation FusionAuth Android SDK

See the FusionAuth Android SDK Documentation for an overview to the SDK. Or see the latest Full library documentation for the complete documentation of the SDK.

Automated End 2 End Testing

While developing the Android SDK we made use of Automated End 2 End Testing within the Android Emulator. This is something useful during App development and we moved the test as well into the quickstart and further documented our testing implementation here.