Spezi Account

A Spezi framework that provides account-related functionality including login, sign up and password reset.

Overview

The SpeziAccount framework fully abstracts setup and management of user account functionality for the Spezi framework ecosystem.

The AccountSetup is the central view for account onboarding, facilitating account login and creation.	The SignupForm is used by email-password-based AccountServices by default.	The AccountOverview is used to view and modify the user details of the currently associated account.

The AccountSetup and AccountOverview views are central to SpeziAccount. You use the AccountDetails abstraction within your views to visualize account information of the associated user account.

An AccountService provides an abstraction layer for managing different types of account management services (e.g., email address and password-based service combined with an identity provider like Sign in with Apple).

For more information, please refer to the API documentation.

[!NOTE] The SpeziFirebase framework provides the FirebaseAccountConfiguration you can use to configure an Account Service base on the Google Firebase service.

Setup

You need to add the Spezi Account Swift package to your app in Xcode or Swift package.

[!IMPORTANT]
If your application is not yet configured to use Spezi, follow the Spezi setup article to set up the core Spezi infrastructure.

The Initial Setup article provides a quick-start guide to set up SpeziAccount in your App. Refer to the Creating your own Account Service article if you plan on implementing your own Account Service.

The Spezi Template Application provides a great starting point and example using the Spezi Account module.

Contributing

Contributions to this project are welcome. Please make sure to read the contribution guidelines and the contributor covenant code of conduct first.

License

This project is licensed under the MIT License. See Licenses for more information.