Console

THIS REPO HAS MOVED!

Streamdal's console allows you visualize interact with your services, build and attach pipelines to consumers and producers and monitor their operations.

_{For more details, see the main
streamdal repo.}

Development

The Console is a Deno + Fresh project that uses Preact, ReactFlow and Twind: https://fresh.deno.dev/docs/getting-started

Make sure to install Deno: https://deno.land/manual/getting_started/installation

Optionally, copy example.env -> .env and set environment variables as needed. By default the console will access the GRPC WEB API running on http://localhost:8083

Then start the project:

deno task start

This will watch the project directory and restart as necessary.

If you make any significant Deno lib and/or configuration changes and your IDE gets confused, you can force update the Deno lib cache with deno cache --reload main.ts

By default, the console will be viewable at: http://localhost:8080

Server

This console needs a streamdal-server to run against. See streamdal/server for instructions on running it locally.

Running (non-development)

If you just want to run the console and the server together for non-development purposes, you can bring them both up with docker, see: https://github.com/streamdal/streamdal/tree/main/docker/local

Dependencies

The console depends on the following dependencies (direct and indirect):

streamdal/server
Envoy (used by Console for gRPC-Web)
Redis (used by streamdal/server)

Releasing

We use https://deno.land/x/version@v1.1.1 to help set our release version. To generate a release:

Install version if you don't already have it: deno install -n version -r -A https://deno.land/x/version/index.ts
Bump the release number: version [major|minor|patch]
git push the generated version tag: git push origin <tag_name>
Generate a release from the tag with user-friendly release notes: https://github.com/streamdal/console/releases