Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 3.03 KB

README.md

File metadata and controls

63 lines (47 loc) · 3.03 KB
Raw

Clowdr: Hasura

We use the Hasura GraphQL engine to power the interface between the frontend and all of our backend services.

Pre-requisites

  1. Docker Compose
  2. Hasura CLI

Setting Up

  1. cp hasura/.env.example hasura/.env.local
  2. In hasura/docker-compose.yaml, comment out the line HASURA_GRAPHQL_JWT_SECRET: ${HASURA_GRAPHQL_JWT_SECRET}. We'll re-enable it once we have a JWT secret.
  3. Run the Hasura Console -- Local Development task within VSCode: Terminal > Run Task.
  4. Check that the Docker Compose task ran successfully in the Task Output
  5. Check that the Hasura Console task ran successfully in the Task Output
    • If you get an error message about version check: failed to get version from server: failed making version api call... try running the task again -- there is a race condition that can cause this.
  6. Your browser should have opened a tab to the Hasura console

Now return to the main README.

Local Development

See root ReadMe instructions for local development for which tasks to run.

Note: If the environment configuration for Hasura/Postgres or the Docker Compose configuration change, then the Hasura local-dev tasks will need to be restarted (which will also apply the changes to Docker).

Remote Deployment

We use GitHub Actions (a.k.a. Workflows) to automatically deploy new versions to Hasura Cloud and run migrations.

Branch Hasura Cloud Instance
develop ci-testing
staging staging
main production

Environment Files

Name Purpose
.env.local Local development
.env.ci-test Hasura Console connection to Hasura Cloud for managing the CI instance
.env.staging Hasura Console connection to Hasura Cloud for managing the staging instance
.env.production Hasura Console connection to Hasura Cloud for managing the production instance

Hasura Cloud Configuration

Env Var Value
HASURA_GRAPHQL_ADMIN_SECRET A secure random value
HASURA_GRAPHQL_DATABASE_URL Allow Hasura to configure this
ACTION_BASE_URL The Heroku Actions Service uri - no trailing slash
PRESENCE_BASE_URL The Heroku Presence Service uri - no trailing slash
EVENT_SECRET The secret to be sent for event trigger auth
HASURA_GRAPHQL_UNAUTHORIZED_ROLE unauthenticated