Spezi

1.2.3

Open-source framework for rapid development of modern, interoperable digital health applications.
StanfordSpezi/Spezi

What's New

1.2.3

2024-03-08T19:17:56Z

What's Changed

  • Fix visibility of NotificationHandler default implementations and make Delegate methods open by @Supereg in #102

Full Changelog: 1.2.2...1.2.3

Spezi

Build and Test codecov DOI

Open-source framework for rapid development of modern, interoperable digital health applications.

Overview

Note

Refer to the Initial Setup instructions on how to integrate Spezi into your application!

Spezi introduces a standards-based modular approach to building digital health applications.

Screenshot displaying the UI of the onboarding module. Screenshot displaying the UI of the onboarding module. Screenshot displaying the UI of the contact module. Screenshot displaying the UI of the contact module. Screenshot displaying the UI of the questionnaire module. Screenshot displaying the UI of the questionnaire module.
The Spezi Onboarding Module The Spezi Contact Module The Spezi Questionnaire Module
Screenshot displaying the account setup view with an email and password prompt and a Sign In with Apple button using the Spezi Account module. Screenshot displaying the account setup view with an email and password prompt and a Sign In with Apple button using the Spezi Account module. Three different kinds of text fields showing validation errors in red text using Spezi Validation package. Three different kinds of text fields showing validation errors in red text using Spezi Validation package. A Chat View of a locally executed LLM using the Spezi LLM module. A Chat View of a locally executed LLM using the Spezi LLM module.
The Spezi Account Module The SpeziValidation package of the Spezi Views Module. The Spezi LLM Module

The best way to get started and explore the functionality of Spezi is by taking a look at the Spezi Template Application. The application incorporates a wide variety of sophisticated modules and demonstrates the usage of these modules in a simple-to-use and easy-to-extend application.

An Ecosystem of Modules

You can find a list of modules and reusable Swift Packages offered by the Spezi team at Stanford at the Swift Package Index Stanford Spezi page.

Note

Spezi relies on an ecosystem of modules. Think about what modules you want to build and contribute to the open-source community! Refer to the Spezi Guide and Documentation Guide about the requirements for Spezi-based software and the Module documentation to learn more about building your modules.

Learn more about Spezi at spezi.stanford.edu. Reach out to us on social media and use the Stanford Spezi Discussion Forum to ask any Spezi-related questions or share the projects you built with Spezi.

Check out the Stanford Biodesign Digital Health GitHub organization and Stanford Biodesign Digital Health website at bdh.stanford.edu, for example, applications built with Spezi and some of our related open-source and research projects.

The Spezi Building Blocks

Note

The Spezi Guide and Documentation Guide guides define the requirements for Spezi-based modules, including terminology, hints, and examples on structuring your Spezi module, Swift Package, and surrounding repository.

A Standard defines the key coordinator that orchestrates the data flow in the application by meeting requirements defined by modules. You can learn more about the Standard protocol and when it is advised to create your own standard in your application in the Standard documentation.

A Module defines a software subsystem providing distinct and reusable functionality. Modules can use the constraint mechanism to enforce a set of requirements to the standard used in the Spezi-based software where the module is used. Modules also define dependencies on each other to reuse functionality and can communicate with other modules by offering and collecting information. They can also conform to different protocols to provide additional access to Spezi features, such as lifecycle management and triggering view updates in SwiftUI using the observable mechanisms in Swift. You can learn more about modules in the Module documentation.

For more information, please refer to the API documentation.

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.

Spezi Footer Spezi Footer

Description

  • Swift Tools 5.9.0
View More Packages from this Author

Dependencies

Last updated: Fri Jun 14 2024 00:08:02 GMT-0900 (Hawaii-Aleutian Daylight Time)