Skip to main content

Development

Dependencies​

Running Komodo from source requires either Docker (and can use the included devcontainer), or can have the development dependencies installed locally:

  • For backend (Komodo core server, periphery, API)
  • For frontend (Web UI)
    • Node >= 18.18 + NPM
      • Yarn - (Tip: use corepack enable after installing node to use yarn)
    • typeshare
    • Deno >= 2.0.2

Docker​

After making changes to the project, run run test-compose-build to rebuild Komodo and then run test-compose-exposed to start a Komodo container with the UI accessible at localhost:9120. Any changes made to source files will require re-running the build and exposed commands.

Devcontainer​

Use the included .devcontainer.json with VSCode or other compatible IDE to stand-up a full environment, including database, with one click.

VSCode Tasks are provded for building and running Komodo.

After opening the repository with the devcontainer run the task Init to build the frontend/backend. Then, the task Run Komodo can be used to run frontend/backend. Other tasks for rebuilding/running only parts of the application are also provided.

Local​

runnables-cli can be used as a convience for running common project tasks (like a Makefile) found in runfile.toml. Otherwise, you can create your own project tasks by references the cmds found in runfile.toml. All instructions below will use runnables-cli.

To run a full Komodo instance from a non-container environment run commands in this order:

  • Ensure dependencies are up to date
    • rustup update -- ensure rust toolchain is up to date
  • Build and Run backend
    • run -r test-core -- builds core binary
    • run -r test-periphery -- builds periphery binary
  • Build Frontend
    • run -r gen-client -- generates TS client and adds to the frontend
    • Prepare API Client
      • cd client/core/ts && yarn && yarn build && yarn link
        • After running once client can be rebuilt with run build-ts-client
    • Prepare Frontend
      • cd frontend && yarn link komodo_client && yarn install
        • After running once client can be built with run build-frontend or started in dev (watch) mode with run start-frontend

Docsite Development​

Use run -r docsite-start to start the Docusaurus Komodo docs site in development mode. Changes made to files in /docsite will be automatically reloaded by the server.