business-stack 0.1.14 → 0.1.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -46
- package/bin/business-stack.cjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -32,68 +32,29 @@ npx --yes business-stack@latest start
|
|
|
32
32
|
|
|
33
33
|
On **Windows Command Prompt**, use the same commands; if `npx` is slow the first time, it is downloading the package.
|
|
34
34
|
|
|
35
|
-
##
|
|
35
|
+
## Quick start
|
|
36
36
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
### 1. Create or use a project directory
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
mkdir my-stack && cd my-stack
|
|
43
|
-
npm init -y
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### 2. Install the package locally
|
|
37
|
+
From a folder with a `package.json` (create one with `npm init -y` if needed):
|
|
47
38
|
|
|
48
39
|
```bash
|
|
49
40
|
npm install business-stack
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
This installs the full app tree at `node_modules/business-stack/` (Next app, gateway, backend sources).
|
|
53
|
-
|
|
54
|
-
### 3. Run the CLI via `npx` (or package scripts)
|
|
55
|
-
|
|
56
|
-
From the **same directory** as your `package.json` (so npm resolves the local install):
|
|
57
|
-
|
|
58
|
-
```bash
|
|
59
41
|
npx business-stack doctor
|
|
60
42
|
npx business-stack setup --yes
|
|
61
43
|
npx business-stack start
|
|
62
44
|
```
|
|
63
45
|
|
|
64
|
-
- **`setup`**
|
|
65
|
-
- **`start`** runs **`npm install
|
|
66
|
-
|
|
67
|
-
Optional flags for `start`: `--skip-install`, `--skip-build`, `--skip-migrate`.
|
|
68
|
-
|
|
69
|
-
**`dev`** (hot reload) is **not** available from the npm package (no app source). Clone the monorepo to develop the stack.
|
|
46
|
+
- **`setup`** writes secrets to `gateway/auth.sqlite` (`stack_secrets`) and creates `gateway/.env`, `frontend/web/.env.local`, and `backend/.env` under the installed package tree.
|
|
47
|
+
- **`start`** runs **`npm install`**, **`uv sync`**, **Better Auth** migrate (gateway SQLite), **Alembic**, then **`npm run start`**. The package is pre-built, so **`npm run build`** is skipped. Flags: `--skip-install`, `--skip-build`, `--skip-migrate`.
|
|
70
48
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
The same install also provides **`bs`** — a **Node** terminal client for auth, chat, ingest, pipeline, etc. (talks to your Next origin, same as the browser). With the stack running:
|
|
49
|
+
**`business-stack dev`** needs full monorepo sources; use **`bs`** for a terminal client against the running web origin:
|
|
74
50
|
|
|
75
51
|
```bash
|
|
76
52
|
bs --help
|
|
77
|
-
bs auth session
|
|
78
|
-
bs backend hello
|
|
79
53
|
```
|
|
80
54
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
### 4. Optional: npm scripts in your `package.json`
|
|
84
|
-
|
|
85
|
-
```json
|
|
86
|
-
{
|
|
87
|
-
"scripts": {
|
|
88
|
-
"stack:doctor": "business-stack doctor",
|
|
89
|
-
"stack:setup": "business-stack setup --yes",
|
|
90
|
-
"stack:start": "business-stack start",
|
|
91
|
-
"stack:dev": "business-stack dev"
|
|
92
|
-
}
|
|
93
|
-
}
|
|
94
|
-
```
|
|
55
|
+
Set **`BUSINESS_STACK_WEB_URL`** (or **`NEXT_PUBLIC_AUTH_BASE_URL`**) to your Next URL (default `http://localhost:3000`). On PowerShell, **`bs -- --help`** if the shell intercepts flags.
|
|
95
56
|
|
|
96
|
-
|
|
57
|
+
Optional **`package.json`** scripts: `"stack:start": "business-stack start"` (and `doctor` / `setup`). Local install adds `node_modules/.bin/business-stack` and `bs`.
|
|
97
58
|
|
|
98
59
|
## Global install (optional)
|
|
99
60
|
|
package/bin/business-stack.cjs
CHANGED