Skip to content

Commit ef4233c

Browse files
Copilothotlong
andcommitted
Document console running modes
- Add clear documentation for Development Mode vs Plugin Mode - Explain when to use each mode - Update README with running mode details - Include port information and use cases Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent efb319a commit ef4233c

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

apps/console/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,31 @@ pnpm test
3333

3434
The console opens at **http://localhost:5175** with a simulated backend (CRM + Todo + Kitchen Sink demo data).
3535

36+
## Running Modes
37+
38+
The console supports two distinct running modes:
39+
40+
### 1. Development Mode (Standalone)
41+
**Command:** `pnpm dev`
42+
43+
- Runs Vite dev server directly with Hot Module Replacement (HMR)
44+
- Uses Mock Service Worker (MSW) to intercept API calls in the browser
45+
- Fast development cycle with instant feedback
46+
- Best for UI development and testing
47+
- Opens at http://localhost:5175
48+
49+
### 2. Plugin Mode (Production-like)
50+
**Command:** `pnpm start`
51+
52+
- Runs via `@objectstack/cli serve` with ObjectStack runtime
53+
- Serves the console as a UI plugin from `dist/` directory
54+
- Tests plugin integration and routing
55+
- Simulates production deployment pattern
56+
- Useful for testing the plugin architecture
57+
- Opens at http://localhost:3000 (default CLI port)
58+
59+
Both modes support the same features and use the same codebase. Choose development mode for fast iteration, and plugin mode to verify deployment behavior.
60+
3661
## ObjectStack Spec Compliance
3762

3863
### AppSchema Support

0 commit comments

Comments
 (0)