You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,8 +71,8 @@ Example: `import { foo } from '@compass/core'` not `import { foo } from '../../.
71
71
72
72
- Install dependencies: `bun install`
73
73
- Takes ~3.5 minutes. Set timeout to 10+ minutes.
74
-
- Bun is the primary install/runtime entrypoint. `bun run cli`, `bun run dev:backend`, core tests, and build packaging now execute through Bun directly.
75
-
- Node 24+ is still required for retained tooling: the web/backend/scripts Jest suites and the production Node build output.
74
+
- Bun is the primary install/runtime entrypoint. `bun run cli`, `bun run dev:web`, `bun run dev:backend`, core tests, and package builds now execute through Bun directly.
75
+
- Node 24+ is still required for retained tooling: the web/backend/scripts Jest suites.
@@ -106,8 +106,8 @@ Run `bun run test:core`, `bun run test:web`, and `bun run test:backend` after ma
106
106
107
107
### Building
108
108
109
-
-**Web Build**: `bun run cli buildweb --environment staging --clientId "test-client-id"`
110
-
-**Node Build**: `bun run cli build nodePckgs --environment staging`
109
+
-**Web Build**: `BUILD_ENV=staging bun run build:web`
110
+
-**Backend Build**: `BUILD_ENV=staging bun run build:backend`
111
111
112
112
### Linting
113
113
@@ -127,7 +127,7 @@ This is a Typescript project with a monorepo structure.
127
127
### Packages Overview
128
128
129
129
-`@compass/backend` - Express.js REST API with MongoDB, Google Calendar sync, Server-Sent Events (SSE)
130
-
-`@compass/web` - React/TypeScript frontend with Redux, styled-components, webpack bundling
130
+
-`@compass/web` - React/TypeScript frontend with Redux, styled-components, Bun HTML bundling
131
131
-`@compass/core` - Shared utilities, types, and business logic
132
132
-`@compass/scripts` - CLI tools for building, database operations, user management
133
133
@@ -209,7 +209,7 @@ packages/core/src/
209
209
-**Test failures**: Run `bun run test:core`, `bun run test:web`, `bun run test:backend`, and `bun run test:scripts` individually to narrow the scope of the failure
210
210
-**Backend won't start**: Missing environment variables in `packages/backend/.env.local`, use web-only development (`bun run dev:web`)
211
211
- Environment: Copy from `packages/backend/.env.local.example` to `packages/backend/.env.local` (there is no `.env.example`).
212
-
-Webpack dev server warns about a missing `.env.local` file; this is harmless—it falls back to `process.env`.
212
+
-Bun HTML serving reads frontend public values from the backend env file loaded via `--env-file`.
213
213
- Husky pre-push hook runs `bunx prettier . --write`, which can modify files. Ensure working tree is clean or committed before pushing.
214
214
215
215
### Network Limitations
@@ -227,9 +227,11 @@ packages/core/src/
227
227
228
228
### Root Level Commands
229
229
230
-
-`bun run cli [command]` - Access CLI tools for build, seed, delete operations
231
-
-`bun run dev:web` - Start the Bun-wrapped webpack dev server
232
-
-`bun run dev:backend` - Start the backend directly with Bun watch mode (requires full environment)
230
+
-`bun run cli [command]` - Access CLI tools for delete, migrate, and seed operations
231
+
-`bun run dev:web` - Start the Bun HTML dev server
232
+
-`bun run dev:backend` - Start the backend directly with Bun hot reload (requires full environment)
233
+
-`bun run build:web` - Build the web app into `build/web`
234
+
-`bun run build:backend` - Build the backend into `build/backend`
233
235
-`bun run test` - Run all tests (fails in restricted environments)
234
236
-`bun run test:core` - Run core package tests only
-**Frontend**: React, Redux, Tailwind CSS, TypeScript, Bun HTML bundling
51
+
-**Backend**: Bun runtime, Express, TypeScript, MongoDB
52
52
-**Integrations**: Google Calendar API, Google OAuth2, Socket.io
53
53
-**Testing**: Bun test (core), retained Jest suites (web/backend/scripts), React Testing Library, Playwright
54
-
-**Other**: Bun is the primary install/runtime/build entrypoint; webpack and Playwright are intentionally retained
54
+
-**Other**: Bun is the primary install/runtime/build entrypoint; Playwright is retained for e2e coverage
55
55
56
56
## Getting Started
57
57
@@ -65,7 +65,7 @@ Want to poke around or self-host?
65
65
66
66
[Read the technical docs](https://github.com/SwitchbackTech/compass/tree/main/docs): All the info you'd need to get started, including guides on how to install, test, build, deploy, and contribute.
67
67
68
-
Use Bun for dependency installation and the default repo commands. Bun now runs the CLI, backend dev flow, core tests, and package builds directly. Node.js 24+ is still required for retained tooling such as the web/backend/scripts Jest suites and the production Node build output.
68
+
Use Bun for dependency installation and the default repo commands. Bun now runs the CLI, web/backend dev flows, core tests, and package builds directly. Node.js 24+ is still required for retained tooling such as the web/backend/scripts Jest suites.
0 commit comments