Skip to content
Prajwol P edited this page Apr 10, 2024 · 4 revisions

Welcome to the browser-ext-mon wiki!

Checklist to start the project

Follow the specific order:

  • 1. Start pocketbase backend (backend/pb)
  • 2. Start oquery backend (backend/osquery-be)
  • 3. Start streamlit frontend app (frontend/streamlit-app)
  • 4. Download binary or build CLI tool (cli)
  • 5. Start extension (extension)

Detailed Steps

1. Start pocketbase backend (backend/pb)

cd backend/pb
docker compose up

During development:

cd backend/pb
docker compose up --build

2. Start oquery backend (backend/osquery-be)

cd backend/osquery-be
docker compose up

During development:

cd backend/osquery-be
docker compose up --build

3. Start streamlit frontend app (frontend/streamlit-app)

cd frontend/streamlit-app
docker compose up

During development:

cd frontend/streamlit-app
docker compose up --build

4. Download binary or build CLI tool (cli)

Either download the latest binary according to your OS from the Releases page, or build from source:

cd cli
go build -o bem-cli
./bem-cli --help

5. Start extension (extension)

Either start the extension in dev mode, or build it, or make sure it is already running on your browser.

To start in dev mode:

cd extension
pnpm install
pnpm dev

To build zipped bundle(s):

cd extension
pnpm install
pnpm build

Then open Chrome or Brave and either load unpacked (for dev mode) or load packed (for zipped bundle) to load the extension.