Skip to content

AGENTS.md

Latest commit

 

History

History
73 lines (51 loc) · 2.95 KB

AGENTS.md

File metadata and controls

73 lines (51 loc) · 2.95 KB

Bkper Apps Monorepo

This repository contains open-source Bkper apps: bots, integrations, and platform apps.

Apps

App Type Location
Bkper CSV App Platform app (Vite + Cloudflare Workers) bkper-csv-app/
Exchange Bot GCP Cloud Functions + Apps Script exchange-bot/
Files Preview App Platform app (Vite + Cloudflare Workers) files-preview-app/
Inventory Bot (legacy) Apps Script + GCP Cloud Functions inventory-bot/legacy/
Inventory Bot (new) Platform app (Vite + Cloudflare Workers) inventory-bot/new/
Portfolio Bot Apps Script + GCP Cloud Functions portfolio-bot/
Subledger Bot GCP Cloud Functions subledger-bot/
Tax Bot GCP Cloud Functions tax-bot/

Port Allocation

All local dev servers should use explicitly assigned ports to avoid conflicts when running in the same devpod workspace. Do not rely on tool defaults — keep each app's local dev configuration aligned with the tables below.

Platform apps (Vite client + bkper app dev server)

App Vite client bkper server Notes
files-preview-app 5174 8788 Configured in vite.config.ts and package.json
inventory-bot/new 5175 8787 Assigned for the new Inventory Bot platform app
bkper-csv-app 5176 8789 Platform replacement for the archived Apps Script CSV app

Avoid default ports. Vite's default 5173 is intentionally skipped to prevent conflicts with other Vite projects running on the host. Always assign an explicit, non-default port.

Next available: Vite client 5177, bkper server 8790.

GCP Cloud Functions bots

App functions-framework port Notes
portfolio-bot/gcf 3002 Configured in portfolio-bot/gcf/package.json
exchange-bot/events 3003 Configured in exchange-bot/events/package.json
subledger-bot 3004 Configured in subledger-bot/package.json
inventory-bot/legacy/events 3005 Configured in inventory-bot/legacy/events/package.json
tax-bot 3041 Configured in tax-bot/package.json

Next available: 3006.

Apps Script components

Apps Script components do not run local dev servers and do not need port assignments:

  • exchange-bot/menu/
  • inventory-bot/legacy/menu/
  • portfolio-bot/gas/

Adding a new app

  1. Choose the next available port in the appropriate category above.
  2. Set the port explicitly in the app's config; do not rely on defaults:
    • Platform apps: server.port in vite.config.ts and --sp in bkper app dev scripts.
    • GCP bots: --port in functions-framework scripts.
  3. Update the Port Allocation table in this file.
  4. Update the root package.json ports script with the new port(s).

Development

Forward all ports

From the repository root:

bun run ports

This runs devpod ssh bkper with port forwards for every active local dev server in the monorepo.