Skip to content
This repository has been archived by the owner on Oct 18, 2023. It is now read-only.

Latest commit

 

History

History
27 lines (22 loc) · 987 Bytes

authentication.md

File metadata and controls

27 lines (22 loc) · 987 Bytes

Authentication

TODO: Add a description for this document and what readers can expect to learn from it.

Setting up authentication

  1. Configure the values in shared/firebase-details.json:
    • authProvider.type - The type of authentication provider to use. Currently, only OAuthProvider and EmailAuthProvider are supported.
    • Based on the type of auth provider, more details are required:
      • OAuthProvider:
        • authProvider.providerId - The ID of the OAuth provider.
        • authProvider.scopes - Optional. A string array of scopes to request from the OAuth provider.
      • EmailAuthProvider:
        • No additional details are required.
  2. From the root of the project, execute the script that will update the Firebase config in the project:
    pnpm run populate-firebase

Per-route authentication control

<route lang="yaml">
meta:
  requiresAuth: false # indicates whether the route requires authentication
</route>