Skip to content

Getting Started

Welcome to the KBVE documentation. This guide walks you through every tool, service, and framework that powers the KBVE ecosystem. You will find setup instructions for the monorepo, descriptions of each project, and tutorials written for developers at every experience level. The stack spans Rust, TypeScript, Python, C#, and several web frameworks, so there is a lot of ground to cover. Start here, explore at your own pace, and refer back whenever you need a refresher.

Tools Overview

Section titled “Tools Overview”

KBVE Jukebox

Stream and discover music through a keyword driven playlist engine built directly into the site.

Listen Now

Webmaster Utility

Audit page performance, inspect SEO metadata, and run diagnostics against any public URL.

Learn More

Automation Suite

Explore workflow automation through software pipelines and hardware integration guides.

Learn More

Prerequisites

Section titled “Prerequisites”

Every dependency in the KBVE monorepo can be installed through Homebrew. Homebrew runs on macOS, Linux, and WSL, so these instructions work across all three platforms. If you do not have Homebrew yet, install it first by running the command on the official site.

For deeper reference on individual tools, see the application docs linked below.

Git
Python
JavaScript
Rust
Docker
Linux

Setup Instructions

Section titled “Setup Instructions”

Follow these steps to clone and run the KBVE monorepo. Each command block can be copied directly into your terminal.

  1. Install Git through Homebrew:

    Terminal window
    brew install git

  2. Install Python 3.14 and confirm the version:

    Terminal window
    brew install [email protected]
    python3.14 --version

  3. Install Node.js and pnpm in one step:

    Terminal window
    brew install node pnpm

  4. Install the .NET SDK for any C# projects in the repo:

    Terminal window
    brew install dotnet

  5. Install Rust through rustup so you can manage toolchains and targets:

    Terminal window
    brew install rustup
    rustup-init

    Follow the on screen prompts, then reload your shell or run source $HOME/.cargo/env.

  6. Add the Rust compilation targets used by KBVE projects:

    Terminal window
    rustup target add wasm32-unknown-unknown
    rustup target add wasm32-wasip1
    rustup target add aarch64-unknown-linux-gnu
    rustup target add x86_64-unknown-linux-gnu

    The wasm32-unknown-unknown target is required for any WebAssembly builds. The wasm32-wasip1 target is used for WASI based server side modules. The Linux targets allow cross compilation from macOS when building release binaries.

  7. Optionally install Docker if you plan to work with containerized services:

    Terminal window
    brew install --cask docker

  8. Clone the KBVE repository:

    Terminal window
    git clone https://github.com/KBVE/kbve.git

  9. Change into the cloned repository directory:

    Terminal window
    cd kbve

  10. Install the project dependencies using pnpm:

    Terminal window
    pnpm install

  11. Start the development server with the code watcher:

    Terminal window
    ./kbve.sh -nx kbve.com:dev

  12. Create a new branch when you are ready to open a pull request:

    Terminal window
    ./kbve.sh -atomic you can type anything here and spaces do not matter

    This generates a branch name from the text you provide after the flag.

  13. Open Visual Studio Code from the repository root if it is not already running:

    Terminal window
    code .

  14. Visual Studio Code will suggest the workspace recommended plugins on first launch. Install them and reload the editor when prompted.

Cleaning and Maintenance

Section titled “Cleaning and Maintenance”

Keeping your local environment clean prevents build errors and dependency conflicts over time. Run pnpm clean periodically to remove stale artifacts, and pull the latest changes from main before starting new work.

Additional Resources

Section titled “Additional Resources”
First Project Checklist A task by task walkthrough for your first contribution to the KBVE monorepo.
Application Navigator Browse the full catalog of application and tool documentation maintained by the team.
Introduction to KBVE Services High level overview of the services, infrastructure, and philosophy behind the project.