@blinkk/live-edit

Live Editor

Experimental.

Editor for providing a rich UI for editing structured data with live previews.

See the typescript docs or example.

Developing

To start developing on the live editor UI run the following:

yarn install
yarn run serve

Then visit https://localhost:8888/ to iterate and improve the editor.

Live edit server

The live edit server is used to deploy the live editor UI using Cloud Run. It contains logic for connecting to different live edit connectors (such as github and local) and loads in the specialized fields (such as for Grow or Amagaki sites) as needed.

To develop locally run yarn run hosted and visit https://localhost:8080/ and iterate and improve. If you are developing on the editor UI, use the yarn run serve command from above instead.

Deployment

The server is automatically built using Docker (using Github actions) and deployed on commits to the main branch.

Production builds are built and deployed when a new tag is created for live-edit repository.

Service account

The server builds use gcloud to build and deploy to a Cloud Run service.

The service account needs to be setup to be a member of the -compute@ service account to deploy from cloud build.:

gcloud iam service-accounts add-iam-policy-binding \
  --project=$PROJECT \
  --member="serviceAccount:$SERVICE_ACCOUNT_EMAIL" \
  --role="roles/iam.serviceAccountUser" \
  $[e-mail]

The service account also needs to have a set of permissions to be able to build and deploy to cloud run.