Stanford Grove

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

Overview

Note

Refer to the Initial Setup instructions to integrate Grove into your application.

Grove introduces a module-based approach to building digital health applications.

Grove Onboarding and Grove Consent	Grove Bluetooth and Grove Devices	Grove Questionnaire
Grove Account	Grove Views , including GroveValidation	Grove LLM

An Ecosystem of Modules

You can find the modules and reusable Swift packages included in this monorepo in Package.swift.

Note

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

Add Grove to Your App

This monorepo version of Grove is distributed as one Swift Package that contains the core Grove library and several optional Grove modules. Add only the products your app needs; for example, most apps start with Grove and then add modules such as GroveViews, GroveOnboarding, GroveConsent, GroveAccount, or GroveHealthKit.

Xcode

1. Open your app project in Xcode.

2. Select File > Add Package Dependencies....

3. Enter the package URL:

   https://github.com/SchmiedmayerLab/Grove.git
   

4. Choose a dependency rule:

   • Choose Up to Next Minor Version.
   • Enter the latest tagged 0.x release.

5. Select the Grove products your app target needs. At minimum, select Grove. Add additional products only when you use them, such as GroveViews, GroveOnboarding, GroveConsent, GroveAccount, or GroveHealthKit.

6. Make sure the products are added to your app target, not only to a test target.

7. Import the modules in Swift files where you use them:

   import Grove
   import GroveViews

Swift Package Manager

If your app or library already has a Package.swift, add this package to the dependencies section:

.package(url: "https://github.com/SchmiedmayerLab/Grove.git", .upToNextMinor(from: "0.3.0"))

Then add the products you use to the target that needs them:

.target(
    name: "MyApp",
    dependencies: [
        .product(name: "Grove", package: "Grove"),
        .product(name: "GroveViews", package: "Grove"),
        .product(name: "GroveOnboarding", package: "Grove")
    ]
)

Use an Xcode or Swift toolchain that supports Swift Package tools version 6.2. If Xcode cannot resolve the package, confirm that the package URL and selected version are correct, then use File > Packages > Resolve Package Versions.

The Grove Building Blocks

Note

The Grove Guide and Documentation Guide outline the requirements for Grove-based modules, including terminology, guidance, and examples on structuring a Grove module, Swift package, and repository.

A Standard defines the key coordinator that orchestrates data flow in an 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 the Standard documentation.

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

For more information, see the Grove documentation catalog.

Contributing

Contributions to this project are welcome. Please make sure to read the contribution guide, the contribution guidelines and the contributor covenant code of conduct first. You can find a list of contributors in the CONTRIBUTORS.md file.

License

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

Citation

If you use this software, please cite it using the metadata in CITATION.cff, which GitHub surfaces through the Cite this repository button.

Our Research

For more information, visit the Schmiedmayer Lab GitHub organization.