Data

Tools

Indexes

Applications

Experiments

Open Source Science

spezifirebase

Google Firebase Spezi Modules

https://github.com/stanfordspezi/spezifirebase

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary

Keywords

cloud firebase ios spezi stanford swift swiftui xcode
Last synced: 6 months ago · JSON representation ·

Repository

Google Firebase Spezi Modules

Basic Info
Statistics
  • Stars: 6
  • Watchers: 11
  • Forks: 1
  • Open Issues: 9
  • Releases: 32
Topics
cloud firebase ios spezi stanford swift swiftui xcode
Created about 3 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

Spezi Firebase

Build and Test codecov DOI

Integrate Google Firebase services into your Spezi application.

Overview

This Module allows you to use the Google Firebase platform as a managed backend for authentication and data storage in your apps built with the Spezi framework.

We currently implement support for Authentication, Storage, and Firestore services.

Setup

You need to add the Spezi Firebase 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.

Examples

The below section walks you through the necessary steps to set up the Spezi Firebase Module for your application.

1. Set up your Firebase Account

To connect your app to the Firebase cloud platform, you will need to first create an account at firebase.google.com then start the process to register a new iOS app.

Once your Spezi app is registered with Firebase, place the generated GoogleService-Info.plist configuration file into the root of your Xcode project. You do not need to add the Firebase SDKs to your app or initialize Firebase in your app, since the Spezi Firebase Module will handle these tasks for you.

You can also install and run the Firebase Local Emulator Suite for local development. To do this, please follow the installation instructions.

2. Add Spezi Firebase as a Dependency

First, you will need to add the SpeziFirebase Swift package to your app in Xcode or Swift package.

3. Register the Spezi Firebase Modules

In the example below, we configure our Spezi application to use Firebase Authentication with both email & password login and Sign in With Apple, and Cloud Firestore for data storage.

```swift import Spezi import SpeziAccount import SpeziFirebaseAccount import SpeziFirebaseStorage import SpeziFirestore import SwiftUI

class ExampleDelegate: SpeziAppDelegate { override var configuration: Configuration { Configuration { AccountConfiguration(configuration: [ .requires(.userId), .collects(.name) ]) Firestore() FirebaseAccountConfiguration[ authenticationMethods: [.emailAndPassword, .signInWithApple] ] } } } ```

For more information, please refer to the API documentation.

The Spezi Template Application

The Spezi Firebase Module comes pre-configured in the Spezi Template Application, which is a great way to get started on your Spezi Application.

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

Owner

  • Name: Stanford Spezi
  • Login: StanfordSpezi
  • Kind: organization

Citation (CITATION.cff) 

#
# This source file is part of the Stanford Spezi open-source project
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
# SPDX-License-Identifier: MIT
#

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Schmiedmayer"
  given-names: "Paul"
  orcid: "https://orcid.org/0000-0002-8607-9148"
- family-names: "Ravi"
  given-names: "Vishnu"
  orcid: "https://orcid.org/0000-0003-0359-1275"
- family-names: "Aalami"
  given-names: "Oliver"
  orcid: "https://orcid.org/0000-0002-7799-2429"
title: "SpeziFirebase"
doi: 10.5281/zenodo.7706899
url: "https://github.com/StanfordSpezi/SpeziFirebase"

GitHub Events

Total
  • Create event: 15
  • Release event: 7
  • Issues event: 4
  • Watch event: 3
  • Delete event: 9
  • Issue comment event: 11
  • Push event: 29
  • Pull request review comment event: 9
  • Pull request review event: 18
  • Pull request event: 15
Last Year
  • Create event: 15
  • Release event: 7
  • Issues event: 4
  • Watch event: 3
  • Delete event: 9
  • Issue comment event: 11
  • Push event: 29
  • Pull request review comment event: 9
  • Pull request review event: 18
  • Pull request event: 15

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 18
  • Total pull requests: 39
  • Average time to close issues: 5 months
  • Average time to close pull requests: 7 days
  • Total issue authors: 5
  • Total pull request authors: 8
  • Average comments per issue: 0.56
  • Average comments per pull request: 1.62
  • Merged pull requests: 36
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 16
  • Average time to close issues: N/A
  • Average time to close pull requests: about 12 hours
  • Issue authors: 2
  • Pull request authors: 4
  • Average comments per issue: 1.33
  • Average comments per pull request: 1.06
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • Supereg (8)
  • PSchmiedmayer (5)
  • vishnuravi (2)
  • philippzagar (1)
  • MatthewTurk247 (1)
Pull Request Authors
  • Supereg (25)
  • PSchmiedmayer (7)
  • lukaskollmer (6)
  • MatthewTurk247 (4)
  • vishnuravi (4)
  • NikolaiMadlener (3)
  • pauljohanneskraft (2)
  • philippzagar (1)
Top Labels
Issue Labels
enhancement (14) good first issue (3) bug (3) help wanted (2)
Pull Request Labels
enhancement (20) bug (12) documentation (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 32
swiftpackageindex.com: github.com/StanfordSpezi/SpeziFirebase

Google Firebase Spezi Modules

  • Versions: 32
  • Dependent Packages: 0
  • Dependent Repositories: 1
Rankings
Dependent repos count: 14.4%
Dependent packages count: 16.6%
Average: 35.5%
Forks count: 41.0%
Stargazers count: 70.0%
Last synced: 6 months ago