Estuary UI

The web UI for Estuary Flow.

How to install?

Make sure Node and npm are installed.

Run: npm install

Troubleshooting

401 error for @estuary/flow-web

You need to update ~/.npmrc with the following:

//npm.pkg.github.com/:_authToken=__YOUR_AUTH_TOKEN_YOU_MADE_ON_GITHUB__
@estuary:registry=https://npm.pkg.github.com/

Github docs.

npm ERR! code EINTEGRITY for data-plane-gateway

Every so often we need to reinstall the data plane stuff to update the integrity with the following:

npm run installDataPlane

Why don't I see logs locally?

You should get logs with V1 Control Plane. You just need to make sure the Ops Catalog is started.

With the update to V2 Control Plane the logs will no longer work in the UI by default. This is due to how the journal selectors for Logs are currently handled. We ned to know about a "pub id" to add to the selector. Currently there is no consistent way for the UI to fetch this.

To get logs you will need to grab this "pub id" and update the query... details TBD.

How to start/run?

Make sure Estuary Flow and Supabase CLI are installed and running.

Run: npm start

The UI is built to hit our own instance of Supabase. That means you will need to have that running locally as well.

How to test against prod?

Run: npm run build

then

Run : npm run preview

This will run a build and then start previewing it. When running as preview you will be running production mode - meaning all the code that runs in prod will be running.

Stuff we use

• TypeScript for code
• MUI for components
• JSON Forms for forms
• Apache ECharts for charts
• Zustand for local state
• Supabase for server calls
• SWR for server calls
• Vite for build