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

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