Skip to content

Latest commit

 

History

History
 
 

web-console

README.md

DBSP Web UI

This is the web UI for the DBSP project.

Setup

# Install nodejs
sudo apt-get update
sudo apt-get install -y ca-certificates curl gnupg
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
NODE_MAJOR=20
echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list
sudo apt-get update
sudo apt-get install nodejs -y

# Install yarn/openapi generator
sudo npm install --global yarn
sudo npm install --global openapi-typescript-codegen

# Clone the repo for the UI
git clone https://github.com/feldera/feldera.git
cd dbsp/web-console

If you don't run ubuntu: other binary distributions for node.js

Development

Install dependencies (needs to be done whenever package.json depencies change):

yarn install

Start the development server:

yarn dev

Build & export static website:

yarn build

Format the code & linting:

yarn format
yarn lint

If yarn audit fails for a transitive dependency you can try to update it:

yarn up --recursive loader-utils

For direct dependencies, you can adjust the version in package.json and run yarn install.

OpenAPI bindings

The bindings for OpenAPI (under $lib/services/manager) are generated using openapi typescript codegen.

If you change the API, execute the following steps to update the bindings:

yarn build-openapi
yarn generate-openapi

Note sometimes strange caching errors may warrant deleting node_modules after regenerating the API bindings.

File Organization

  • @core/: Settings, style and MUI overrides.
  • lib/: Imported modules
  • lib/components/: Reusable React components.
  • lib/compositions/: Modules that encapsulate app state management
  • lib/functions/: Pure functions, or functions that perform side effects through dependency injection
  • lib/functions/common: Utility functions that are not specific to this project
  • lib/services/: Functions that describe side effects (persistent storage, networking etc.)
  • lib/types/: Types used throughout the app, OpenAPI generated types.
  • pages/: Webapp pages used by file-based routing