Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ one [model provider](https://github.com/corbitsdev/corbits-builder/blob/main/doc
changing `apps/hub`, `workflows/` or `packages/`. If a port is taken, set
`PORT` or `DB_PORT` in `.env.hub` (and `UI_HUB_ORIGIN` in `.env.web` to
match `PORT`), or `UI_PORT` in `.env.web`.
`bun run dev:stop` stops the whole stack, including anything an earlier
run left behind, and names whatever else holds a port `bun run dev` needs,
such as another project's dev server or the Compose stack.

5. Sign in. Open http://localhost:5173 and choose **Create an account** with
any email and password. Locally there is no email to verify.
Expand Down
35 changes: 18 additions & 17 deletions docs/DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,23 +78,24 @@ real API ([CONTRIBUTING.md](https://github.com/corbitsdev/corbits-builder/blob/m

## Other scripts

| Script | What it does |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `bun run start` | Starts the hub alone, without the migrations or the UI dev server. |
| `bun run dev:hub` | Starts the hub alone for the UI dev server on `UI_PORT` (from the shell; `bun run dev` also reads it from `.env.web`). |
| `bun run dev:web` | Starts the UI dev server alone. |
| `bun run format` | Formats the tree with bun fmt. |
| `bun run lint` | oxlint, warnings are errors. |
| `bun run typecheck` | Typechecks the hub, the client API and the UI. |
| `bun run db:migrate` | Applies the migrations. |
| `bun run db:generate` | Generates a migration from `apps/hub/src/db/schema.ts`. |
| `bun run docker:up` | Builds and starts Builder in Docker ([SELF_HOST.md](https://github.com/corbitsdev/corbits-builder/blob/main/docs/SELF_HOST.md)). |
| `bun run docker:sidecar` | Builds the sidecar Docker image. |
| `bun run auth:bootstrap` | Migrates and creates the `BOOTSTRAP_*` machine account and workspace. |
| `bun run auth:emulate` | Starts a loopback Google sign-in emulator (`GOOGLE_EMULATE_URL` in `.env.hub.example`). |
| `bun run dev:seed` | Seeds dummy projects (`habit-tracker`, `field-service-dispatch`, `clinical-trial-intake`) at a chosen lifecycle stage. |
| `bun run vendor:verify` | Checks `vendor/interchange` matches its pinned upstream commit. |
| `bun run skills:react-ui` | Regenerates the designer's `@corbits/react-ui` API reference. |
| Script | What it does |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bun run start` | Starts the hub alone, without the migrations or the UI dev server. |
| `bun run dev:hub` | Starts the hub alone for the UI dev server on `UI_PORT` (from the shell; `bun run dev` also reads it from `.env.web`). |
| `bun run dev:web` | Starts the UI dev server alone. |
| `bun run dev:stop` | Stops every Builder process on this machine (hubs, migrations, UI dev servers, what they spawned) and names whatever else holds a port `bun run dev` needs; `--dry-run` only lists them. |
| `bun run format` | Formats the tree with bun fmt. |
| `bun run lint` | oxlint, warnings are errors. |
| `bun run typecheck` | Typechecks the hub, the client API and the UI. |
| `bun run db:migrate` | Applies the migrations. |
| `bun run db:generate` | Generates a migration from `apps/hub/src/db/schema.ts`. |
| `bun run docker:up` | Builds and starts Builder in Docker ([SELF_HOST.md](https://github.com/corbitsdev/corbits-builder/blob/main/docs/SELF_HOST.md)). |
| `bun run docker:sidecar` | Builds the sidecar Docker image. |
| `bun run auth:bootstrap` | Migrates and creates the `BOOTSTRAP_*` machine account and workspace. |
| `bun run auth:emulate` | Starts a loopback Google sign-in emulator (`GOOGLE_EMULATE_URL` in `.env.hub.example`). |
| `bun run dev:seed` | Seeds dummy projects (`habit-tracker`, `field-service-dispatch`, `clinical-trial-intake`) at a chosen lifecycle stage. |
| `bun run vendor:verify` | Checks `vendor/interchange` matches its pinned upstream commit. |
| `bun run skills:react-ui` | Regenerates the designer's `@corbits/react-ui` API reference. |

## Migrations

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"dev": "bun run db:migrate && bun --env-file=.env.web run --parallel dev:hub dev:web",
"dev:hub": "UI_PUBLIC_URL=http://localhost:${UI_PORT:-5173} bun run start",
"dev:web": "bun --env-file=.env.web run --cwd apps/web dev",
"dev:stop": "bun scripts/dev-stop.ts",
"start": "exec bun --env-file=.env.hub --conditions=intx-src apps/hub/src/server.ts",
"db:migrate": "bun --env-file=.env.hub --conditions=intx-src apps/hub/src/migrate.ts",
"db:generate": "bun --conditions=intx-src ./node_modules/drizzle-kit/bin.cjs generate --config=apps/hub/drizzle.config.ts",
Expand Down
Loading