@quickback-dev/cli 0.10.16 → 0.11.0
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/dist/commands/compile.d.ts.map +1 -1
- package/dist/commands/compile.js +40 -2
- package/dist/commands/compile.js.map +1 -1
- package/dist/docs/content.d.ts.map +1 -1
- package/dist/docs/content.js +15 -10
- package/dist/docs/content.js.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/skill/SKILL.md +142 -1051
- package/dist/skill/agents/quickback-specialist/AGENT.md +36 -0
- package/dist/skill/docs/changelog.md +1225 -0
- package/dist/skill/docs/compiler/claude-code-skill.md +312 -0
- package/dist/skill/docs/compiler/cloud-compiler/authentication.md +63 -0
- package/dist/skill/docs/compiler/cloud-compiler/cli.md +307 -0
- package/dist/skill/docs/compiler/cloud-compiler/endpoints.md +78 -0
- package/dist/skill/docs/compiler/cloud-compiler/index.md +65 -0
- package/dist/skill/docs/compiler/cloud-compiler/local-compiler.md +115 -0
- package/dist/skill/docs/compiler/cloud-compiler/troubleshooting.md +76 -0
- package/dist/skill/docs/compiler/config/agents.md +144 -0
- package/dist/skill/docs/compiler/config/auth.md +109 -0
- package/dist/skill/docs/compiler/config/bindings.md +176 -0
- package/dist/skill/docs/compiler/config/domains.md +149 -0
- package/dist/skill/docs/compiler/config/index.md +419 -0
- package/dist/skill/docs/compiler/config/output.md +338 -0
- package/dist/skill/docs/compiler/config/providers.md +248 -0
- package/dist/skill/docs/compiler/config/security.md +255 -0
- package/dist/skill/docs/compiler/config/single-tenant.md +128 -0
- package/dist/skill/docs/compiler/config/variables.md +157 -0
- package/dist/skill/docs/compiler/definitions/access.md +445 -0
- package/dist/skill/docs/compiler/definitions/actions.md +884 -0
- package/dist/skill/docs/compiler/definitions/concepts.md +52 -0
- package/dist/skill/docs/compiler/definitions/feature.md +164 -0
- package/dist/skill/docs/compiler/definitions/firewall.md +285 -0
- package/dist/skill/docs/compiler/definitions/guards.md +241 -0
- package/dist/skill/docs/compiler/definitions/index.md +219 -0
- package/dist/skill/docs/compiler/definitions/masking.md +241 -0
- package/dist/skill/docs/compiler/definitions/read.md +220 -0
- package/dist/skill/docs/compiler/definitions/schema.md +697 -0
- package/dist/skill/docs/compiler/definitions/validation.md +35 -0
- package/dist/skill/docs/compiler/definitions/views.md +292 -0
- package/dist/skill/docs/compiler/getting-started/claude-code.md +126 -0
- package/dist/skill/docs/compiler/getting-started/full-example.md +431 -0
- package/dist/skill/docs/compiler/getting-started/hand-crafted.md +178 -0
- package/dist/skill/docs/compiler/getting-started/index.md +192 -0
- package/dist/skill/docs/compiler/getting-started/patterns.md +225 -0
- package/dist/skill/docs/compiler/getting-started/template-blog.md +280 -0
- package/dist/skill/docs/compiler/getting-started/template-cloudflare.md +260 -0
- package/dist/skill/docs/compiler/getting-started/template-empty.md +112 -0
- package/dist/skill/docs/compiler/getting-started/templates.md +111 -0
- package/dist/skill/docs/compiler/index.md +85 -0
- package/dist/skill/docs/compiler/targets/hono-api/cloudflare.md +94 -0
- package/dist/skill/docs/compiler/targets/hono-api/database/d1.md +246 -0
- package/dist/skill/docs/compiler/targets/hono-api/database/index.md +16 -0
- package/dist/skill/docs/compiler/targets/hono-api/database/neon.md +144 -0
- package/dist/skill/docs/compiler/targets/hono-api/database/using-d1.md +39 -0
- package/dist/skill/docs/compiler/targets/hono-api/index.md +37 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/actions-api.md +323 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/batch-operations.md +357 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/caching.md +105 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/crud.md +652 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/errors.md +224 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/index.md +37 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/openapi.md +203 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/query-params.md +199 -0
- package/dist/skill/docs/compiler/targets/hono-api/using-the-api/views-api.md +161 -0
- package/dist/skill/docs/compiler/targets/index.md +47 -0
- package/dist/skill/docs/compiler/targets/supabase-rls/index.md +55 -0
- package/dist/skill/docs/compiler/targets/supabase-rls/limitations.md +48 -0
- package/dist/skill/docs/compiler/targets/supabase-rls/mappings.md +99 -0
- package/dist/skill/docs/compiler/targets/supabase-rls/setup.md +88 -0
- package/dist/skill/docs/compiler/troubleshooting.md +120 -0
- package/dist/skill/docs/index.md +77 -0
- package/dist/skill/docs/stack/account-ui/customization.md +378 -0
- package/dist/skill/docs/stack/account-ui/environment-variables.md +325 -0
- package/dist/skill/docs/stack/account-ui/features/admin.md +76 -0
- package/dist/skill/docs/stack/account-ui/features/api-keys.md +22 -0
- package/dist/skill/docs/stack/account-ui/features/avatars.md +37 -0
- package/dist/skill/docs/stack/account-ui/features/cli-authorize.md +21 -0
- package/dist/skill/docs/stack/account-ui/features/index.md +291 -0
- package/dist/skill/docs/stack/account-ui/features/organizations.md +29 -0
- package/dist/skill/docs/stack/account-ui/features/passkeys.md +31 -0
- package/dist/skill/docs/stack/account-ui/features/passwordless.md +28 -0
- package/dist/skill/docs/stack/account-ui/features/sessions.md +20 -0
- package/dist/skill/docs/stack/account-ui/hooks.md +209 -0
- package/dist/skill/docs/stack/account-ui/index.md +147 -0
- package/dist/skill/docs/stack/account-ui/library-usage.md +257 -0
- package/dist/skill/docs/stack/account-ui/standalone.md +149 -0
- package/dist/skill/docs/stack/account-ui/with-quickback.md +160 -0
- package/dist/skill/docs/stack/account-ui/worker.md +362 -0
- package/dist/skill/docs/stack/auth/api-keys.md +15 -0
- package/dist/skill/docs/stack/auth/device-auth.md +14 -0
- package/dist/skill/docs/stack/auth/index.md +64 -0
- package/dist/skill/docs/stack/auth/jwt-optimization.md +245 -0
- package/dist/skill/docs/stack/auth/plugins/aws-ses.md +127 -0
- package/dist/skill/docs/stack/auth/plugins/combo-auth.md +74 -0
- package/dist/skill/docs/stack/auth/plugins/index.md +340 -0
- package/dist/skill/docs/stack/auth/plugins/upgrade-anonymous.md +155 -0
- package/dist/skill/docs/stack/auth/security.md +455 -0
- package/dist/skill/docs/stack/auth/using-auth.md +39 -0
- package/dist/skill/docs/stack/cms/actions.md +199 -0
- package/dist/skill/docs/stack/cms/components.md +479 -0
- package/dist/skill/docs/stack/cms/connecting.md +199 -0
- package/dist/skill/docs/stack/cms/dashboard.md +39 -0
- package/dist/skill/docs/stack/cms/index.md +158 -0
- package/dist/skill/docs/stack/cms/inline-editing.md +136 -0
- package/dist/skill/docs/stack/cms/pages.md +275 -0
- package/dist/skill/docs/stack/cms/record-layouts.md +151 -0
- package/dist/skill/docs/stack/cms/schema-format.md +437 -0
- package/dist/skill/docs/stack/cms/schema-registry.md +200 -0
- package/dist/skill/docs/stack/cms/security.md +203 -0
- package/dist/skill/docs/stack/cms/table-views.md +142 -0
- package/dist/skill/docs/stack/index.md +65 -0
- package/dist/skill/docs/stack/queues/handlers.md +317 -0
- package/dist/skill/docs/stack/queues/index.md +56 -0
- package/dist/skill/docs/stack/queues/using-queues.md +192 -0
- package/dist/skill/docs/stack/realtime/durable-objects.md +488 -0
- package/dist/skill/docs/stack/realtime/index.md +73 -0
- package/dist/skill/docs/stack/realtime/partyserver-rooms.md +146 -0
- package/dist/skill/docs/stack/realtime/using-realtime.md +211 -0
- package/dist/skill/docs/stack/storage/index.md +17 -0
- package/dist/skill/docs/stack/storage/kv.md +204 -0
- package/dist/skill/docs/stack/storage/r2.md +232 -0
- package/dist/skill/docs/stack/storage/using-kv.md +70 -0
- package/dist/skill/docs/stack/storage/using-r2.md +55 -0
- package/dist/skill/docs/stack/vector/embeddings.md +554 -0
- package/dist/skill/docs/stack/vector/index.md +44 -0
- package/dist/skill/docs/stack/vector/using-embeddings.md +186 -0
- package/dist/skill/docs/stack/webhooks/inbound.md +186 -0
- package/dist/skill/docs/stack/webhooks/index.md +36 -0
- package/dist/skill/docs/stack/webhooks/outbound.md +281 -0
- package/package.json +1 -1
- package/src/skill/SKILL.md +142 -1051
- package/src/skill/agents/quickback-specialist/AGENT.md +36 -0
- package/src/skill/docs/changelog.md +1225 -0
- package/src/skill/docs/compiler/claude-code-skill.md +312 -0
- package/src/skill/docs/compiler/cloud-compiler/authentication.md +63 -0
- package/src/skill/docs/compiler/cloud-compiler/cli.md +307 -0
- package/src/skill/docs/compiler/cloud-compiler/endpoints.md +78 -0
- package/src/skill/docs/compiler/cloud-compiler/index.md +65 -0
- package/src/skill/docs/compiler/cloud-compiler/local-compiler.md +115 -0
- package/src/skill/docs/compiler/cloud-compiler/troubleshooting.md +76 -0
- package/src/skill/docs/compiler/config/agents.md +144 -0
- package/src/skill/docs/compiler/config/auth.md +109 -0
- package/src/skill/docs/compiler/config/bindings.md +176 -0
- package/src/skill/docs/compiler/config/domains.md +149 -0
- package/src/skill/docs/compiler/config/index.md +419 -0
- package/src/skill/docs/compiler/config/output.md +338 -0
- package/src/skill/docs/compiler/config/providers.md +248 -0
- package/src/skill/docs/compiler/config/security.md +255 -0
- package/src/skill/docs/compiler/config/single-tenant.md +128 -0
- package/src/skill/docs/compiler/config/variables.md +157 -0
- package/src/skill/docs/compiler/definitions/access.md +445 -0
- package/src/skill/docs/compiler/definitions/actions.md +884 -0
- package/src/skill/docs/compiler/definitions/concepts.md +52 -0
- package/src/skill/docs/compiler/definitions/feature.md +164 -0
- package/src/skill/docs/compiler/definitions/firewall.md +285 -0
- package/src/skill/docs/compiler/definitions/guards.md +241 -0
- package/src/skill/docs/compiler/definitions/index.md +219 -0
- package/src/skill/docs/compiler/definitions/masking.md +241 -0
- package/src/skill/docs/compiler/definitions/read.md +220 -0
- package/src/skill/docs/compiler/definitions/schema.md +697 -0
- package/src/skill/docs/compiler/definitions/validation.md +35 -0
- package/src/skill/docs/compiler/definitions/views.md +292 -0
- package/src/skill/docs/compiler/getting-started/claude-code.md +126 -0
- package/src/skill/docs/compiler/getting-started/full-example.md +431 -0
- package/src/skill/docs/compiler/getting-started/hand-crafted.md +178 -0
- package/src/skill/docs/compiler/getting-started/index.md +192 -0
- package/src/skill/docs/compiler/getting-started/patterns.md +225 -0
- package/src/skill/docs/compiler/getting-started/template-blog.md +280 -0
- package/src/skill/docs/compiler/getting-started/template-cloudflare.md +260 -0
- package/src/skill/docs/compiler/getting-started/template-empty.md +112 -0
- package/src/skill/docs/compiler/getting-started/templates.md +111 -0
- package/src/skill/docs/compiler/index.md +85 -0
- package/src/skill/docs/compiler/targets/hono-api/cloudflare.md +94 -0
- package/src/skill/docs/compiler/targets/hono-api/database/d1.md +246 -0
- package/src/skill/docs/compiler/targets/hono-api/database/index.md +16 -0
- package/src/skill/docs/compiler/targets/hono-api/database/neon.md +144 -0
- package/src/skill/docs/compiler/targets/hono-api/database/using-d1.md +39 -0
- package/src/skill/docs/compiler/targets/hono-api/index.md +37 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/actions-api.md +323 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/batch-operations.md +357 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/caching.md +105 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/crud.md +652 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/errors.md +224 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/index.md +37 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/openapi.md +203 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/query-params.md +199 -0
- package/src/skill/docs/compiler/targets/hono-api/using-the-api/views-api.md +161 -0
- package/src/skill/docs/compiler/targets/index.md +47 -0
- package/src/skill/docs/compiler/targets/supabase-rls/index.md +55 -0
- package/src/skill/docs/compiler/targets/supabase-rls/limitations.md +48 -0
- package/src/skill/docs/compiler/targets/supabase-rls/mappings.md +99 -0
- package/src/skill/docs/compiler/targets/supabase-rls/setup.md +88 -0
- package/src/skill/docs/compiler/troubleshooting.md +120 -0
- package/src/skill/docs/index.md +77 -0
- package/src/skill/docs/stack/account-ui/customization.md +378 -0
- package/src/skill/docs/stack/account-ui/environment-variables.md +325 -0
- package/src/skill/docs/stack/account-ui/features/admin.md +76 -0
- package/src/skill/docs/stack/account-ui/features/api-keys.md +22 -0
- package/src/skill/docs/stack/account-ui/features/avatars.md +37 -0
- package/src/skill/docs/stack/account-ui/features/cli-authorize.md +21 -0
- package/src/skill/docs/stack/account-ui/features/index.md +291 -0
- package/src/skill/docs/stack/account-ui/features/organizations.md +29 -0
- package/src/skill/docs/stack/account-ui/features/passkeys.md +31 -0
- package/src/skill/docs/stack/account-ui/features/passwordless.md +28 -0
- package/src/skill/docs/stack/account-ui/features/sessions.md +20 -0
- package/src/skill/docs/stack/account-ui/hooks.md +209 -0
- package/src/skill/docs/stack/account-ui/index.md +147 -0
- package/src/skill/docs/stack/account-ui/library-usage.md +257 -0
- package/src/skill/docs/stack/account-ui/standalone.md +149 -0
- package/src/skill/docs/stack/account-ui/with-quickback.md +160 -0
- package/src/skill/docs/stack/account-ui/worker.md +362 -0
- package/src/skill/docs/stack/auth/api-keys.md +15 -0
- package/src/skill/docs/stack/auth/device-auth.md +14 -0
- package/src/skill/docs/stack/auth/index.md +64 -0
- package/src/skill/docs/stack/auth/jwt-optimization.md +245 -0
- package/src/skill/docs/stack/auth/plugins/aws-ses.md +127 -0
- package/src/skill/docs/stack/auth/plugins/combo-auth.md +74 -0
- package/src/skill/docs/stack/auth/plugins/index.md +340 -0
- package/src/skill/docs/stack/auth/plugins/upgrade-anonymous.md +155 -0
- package/src/skill/docs/stack/auth/security.md +455 -0
- package/src/skill/docs/stack/auth/using-auth.md +39 -0
- package/src/skill/docs/stack/cms/actions.md +199 -0
- package/src/skill/docs/stack/cms/components.md +479 -0
- package/src/skill/docs/stack/cms/connecting.md +199 -0
- package/src/skill/docs/stack/cms/dashboard.md +39 -0
- package/src/skill/docs/stack/cms/index.md +158 -0
- package/src/skill/docs/stack/cms/inline-editing.md +136 -0
- package/src/skill/docs/stack/cms/pages.md +275 -0
- package/src/skill/docs/stack/cms/record-layouts.md +151 -0
- package/src/skill/docs/stack/cms/schema-format.md +437 -0
- package/src/skill/docs/stack/cms/schema-registry.md +200 -0
- package/src/skill/docs/stack/cms/security.md +203 -0
- package/src/skill/docs/stack/cms/table-views.md +142 -0
- package/src/skill/docs/stack/index.md +65 -0
- package/src/skill/docs/stack/queues/handlers.md +317 -0
- package/src/skill/docs/stack/queues/index.md +56 -0
- package/src/skill/docs/stack/queues/using-queues.md +192 -0
- package/src/skill/docs/stack/realtime/durable-objects.md +488 -0
- package/src/skill/docs/stack/realtime/index.md +73 -0
- package/src/skill/docs/stack/realtime/partyserver-rooms.md +146 -0
- package/src/skill/docs/stack/realtime/using-realtime.md +211 -0
- package/src/skill/docs/stack/storage/index.md +17 -0
- package/src/skill/docs/stack/storage/kv.md +204 -0
- package/src/skill/docs/stack/storage/r2.md +232 -0
- package/src/skill/docs/stack/storage/using-kv.md +70 -0
- package/src/skill/docs/stack/storage/using-r2.md +55 -0
- package/src/skill/docs/stack/vector/embeddings.md +554 -0
- package/src/skill/docs/stack/vector/index.md +44 -0
- package/src/skill/docs/stack/vector/using-embeddings.md +186 -0
- package/src/skill/docs/stack/webhooks/inbound.md +186 -0
- package/src/skill/docs/stack/webhooks/index.md +36 -0
- package/src/skill/docs/stack/webhooks/outbound.md +281 -0
|
@@ -0,0 +1,325 @@
|
|
|
1
|
+
# Environment Variables
|
|
2
|
+
|
|
3
|
+
Configure the Account UI by setting environment variables in your `.env` file or deployment platform.
|
|
4
|
+
|
|
5
|
+
## Quick Setup — Single Variable
|
|
6
|
+
|
|
7
|
+
For the common "unified deployment" where API, Account, and CMS all live on the same Quickback origin, you only need **one** variable:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Points at the Quickback Worker origin
|
|
11
|
+
VITE_QUICKBACK_URL=https://secure.example.com
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
When `VITE_QUICKBACK_URL` is set, it's used as a fallback for the individual URL vars:
|
|
15
|
+
|
|
16
|
+
| Individual var | Used first | Falls back to |
|
|
17
|
+
|---|---|---|
|
|
18
|
+
| `VITE_QUICKBACK_API_URL` | if set | `${VITE_QUICKBACK_URL}` |
|
|
19
|
+
| `VITE_QUICKBACK_ACCOUNT_URL` | if set | `${VITE_QUICKBACK_URL}/account` |
|
|
20
|
+
| `VITE_QUICKBACK_CMS_URL` | if set | `${VITE_QUICKBACK_URL}/cms` |
|
|
21
|
+
|
|
22
|
+
> **VITE_QUICKBACK_APP_URL is independent**
|
|
23
|
+
>
|
|
24
|
+
> `VITE_QUICKBACK_APP_URL` points at the tenant's own frontend (where users are redirected after login). It's **not** derived from `VITE_QUICKBACK_URL` — set it separately if needed.
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## Required Variables
|
|
28
|
+
|
|
29
|
+
At minimum, you need one of:
|
|
30
|
+
|
|
31
|
+
- **`VITE_QUICKBACK_URL`** — catch-all for the Quickback origin (recommended), **or**
|
|
32
|
+
- **`VITE_QUICKBACK_API_URL`** — explicit API URL (use this if your API lives on a different subdomain from Account/CMS)
|
|
33
|
+
|
|
34
|
+
### Split-subdomain setup
|
|
35
|
+
|
|
36
|
+
If your API, Account, and CMS live on separate custom subdomains, set them explicitly:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
# Quickback API URL
|
|
40
|
+
VITE_QUICKBACK_API_URL=https://api.example.com
|
|
41
|
+
|
|
42
|
+
# Account UI URL (where the Account UI is deployed)
|
|
43
|
+
VITE_ACCOUNT_APP_URL=https://account.example.com
|
|
44
|
+
|
|
45
|
+
# Optional: override Account/CMS URLs for cross-origin links
|
|
46
|
+
VITE_QUICKBACK_ACCOUNT_URL=https://auth.example.com
|
|
47
|
+
VITE_QUICKBACK_CMS_URL=https://cms.example.com
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
> **Required Configuration**
|
|
51
|
+
>
|
|
52
|
+
> The application will throw an error if neither `VITE_QUICKBACK_URL` nor `VITE_QUICKBACK_API_URL` is set.
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
## App Identity
|
|
56
|
+
|
|
57
|
+
Configure your application's basic information:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# App name (displayed in UI)
|
|
61
|
+
VITE_APP_NAME=My Application
|
|
62
|
+
|
|
63
|
+
# Tagline (shown on landing pages)
|
|
64
|
+
VITE_APP_TAGLINE=Build faster, ship sooner
|
|
65
|
+
|
|
66
|
+
# Full description
|
|
67
|
+
VITE_APP_DESCRIPTION=A complete platform for building modern web applications
|
|
68
|
+
|
|
69
|
+
# Company information
|
|
70
|
+
VITE_COMPANY_NAME=My Company Inc.
|
|
71
|
+
VITE_COMPANY_ADDRESS=123 Main St, Suite 100, San Francisco, CA 94105
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## URLs
|
|
75
|
+
|
|
76
|
+
### Main Application
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
# Your main application URL
|
|
80
|
+
# Users will be redirected here after authentication
|
|
81
|
+
VITE_QUICKBACK_APP_URL=https://app.example.com
|
|
82
|
+
|
|
83
|
+
# Organization/Tenant URL pattern (optional)
|
|
84
|
+
# Use {slug} as placeholder for organization identifier
|
|
85
|
+
# Examples:
|
|
86
|
+
# /organizations/{slug} -> app.example.com/organizations/acme
|
|
87
|
+
# /workspace/{slug} -> app.example.com/workspace/acme
|
|
88
|
+
# https://{slug}.example.com -> acme.example.com
|
|
89
|
+
VITE_TENANT_URL_PATTERN=/organizations/{slug}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Support and Legal
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
# Support/help URL
|
|
96
|
+
VITE_SUPPORT_URL=https://support.example.com
|
|
97
|
+
|
|
98
|
+
# Privacy policy URL
|
|
99
|
+
VITE_PRIVACY_URL=https://example.com/privacy
|
|
100
|
+
|
|
101
|
+
# Terms of service URL
|
|
102
|
+
VITE_TERMS_URL=https://example.com/terms
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Email Configuration
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
# From address for all emails
|
|
109
|
+
VITE_EMAIL_FROM=noreply@example.com
|
|
110
|
+
|
|
111
|
+
# Reply-to address
|
|
112
|
+
VITE_EMAIL_REPLY_TO=support@example.com
|
|
113
|
+
|
|
114
|
+
# Support email address
|
|
115
|
+
VITE_SUPPORT_EMAIL=support@example.com
|
|
116
|
+
|
|
117
|
+
# AWS Region for SES (if using AWS SES)
|
|
118
|
+
VITE_EMAIL_REGION=us-east-1
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Branding
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
# Primary theme color (hex code)
|
|
125
|
+
VITE_THEME_COLOR=#1e293b
|
|
126
|
+
|
|
127
|
+
# SEO keywords (comma-separated)
|
|
128
|
+
VITE_SEO_KEYWORDS=saas,authentication,account management
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## Feature Flags
|
|
132
|
+
|
|
133
|
+
Enable or disable features using boolean environment variables:
|
|
134
|
+
|
|
135
|
+
### Authentication Features
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
# Enable user signup (default: true)
|
|
139
|
+
ENABLE_SIGNUP=true
|
|
140
|
+
|
|
141
|
+
# Enable email verification after signup (default: true)
|
|
142
|
+
ENABLE_EMAIL_VERIFICATION=true
|
|
143
|
+
|
|
144
|
+
# Disable email deliverability checks (default: false)
|
|
145
|
+
# Set to true to skip checking if email addresses are deliverable
|
|
146
|
+
DISABLE_EMAIL_STATUS_CHECK=false
|
|
147
|
+
|
|
148
|
+
# Enable passkey (WebAuthn) login (default: true)
|
|
149
|
+
ENABLE_PASSKEY=true
|
|
150
|
+
|
|
151
|
+
# Enable email OTP login and signup (default: true)
|
|
152
|
+
ENABLE_EMAIL_OTP=true
|
|
153
|
+
|
|
154
|
+
# Enable email+password login and signup (default: false)
|
|
155
|
+
ENABLE_PASSWORD=false
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Account Management Features
|
|
159
|
+
|
|
160
|
+
```bash
|
|
161
|
+
# Enable file uploads (avatar, etc.) (default: false)
|
|
162
|
+
VITE_ENABLE_FILE_UPLOADS=false
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### Organization Features
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
# Enable multi-tenant organizations (default: true)
|
|
169
|
+
ENABLE_ORGANIZATIONS=true
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Admin Features
|
|
173
|
+
|
|
174
|
+
```bash
|
|
175
|
+
# Enable admin panel (default: true)
|
|
176
|
+
ENABLE_ADMIN=true
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
## Complete Example
|
|
180
|
+
|
|
181
|
+
Here's a complete `.env` file with all common configuration:
|
|
182
|
+
|
|
183
|
+
```bash title=".env"
|
|
184
|
+
# ===== REQUIRED =====
|
|
185
|
+
VITE_QUICKBACK_API_URL=https://api.example.com
|
|
186
|
+
VITE_ACCOUNT_APP_URL=https://account.example.com
|
|
187
|
+
|
|
188
|
+
# ===== APP IDENTITY =====
|
|
189
|
+
VITE_APP_NAME=Acme SaaS
|
|
190
|
+
VITE_APP_TAGLINE=Build faster, ship sooner
|
|
191
|
+
VITE_APP_DESCRIPTION=The complete platform for modern web applications
|
|
192
|
+
VITE_COMPANY_NAME=Acme Corporation
|
|
193
|
+
VITE_COMPANY_ADDRESS=123 Main St, Suite 100, San Francisco, CA 94105
|
|
194
|
+
|
|
195
|
+
# ===== URLS =====
|
|
196
|
+
VITE_QUICKBACK_APP_URL=https://app.acme.com
|
|
197
|
+
VITE_TENANT_URL_PATTERN=/organizations/{slug}
|
|
198
|
+
VITE_SUPPORT_URL=https://help.acme.com
|
|
199
|
+
VITE_PRIVACY_URL=https://acme.com/privacy
|
|
200
|
+
VITE_TERMS_URL=https://acme.com/terms
|
|
201
|
+
|
|
202
|
+
# ===== EMAIL =====
|
|
203
|
+
VITE_EMAIL_FROM=noreply@acme.com
|
|
204
|
+
VITE_EMAIL_REPLY_TO=support@acme.com
|
|
205
|
+
VITE_SUPPORT_EMAIL=support@acme.com
|
|
206
|
+
VITE_EMAIL_REGION=us-east-1
|
|
207
|
+
|
|
208
|
+
# ===== BRANDING =====
|
|
209
|
+
VITE_THEME_COLOR=#3b82f6
|
|
210
|
+
|
|
211
|
+
# ===== SEO =====
|
|
212
|
+
VITE_SEO_KEYWORDS=saas,project management,team collaboration
|
|
213
|
+
|
|
214
|
+
# ===== FEATURES =====
|
|
215
|
+
ENABLE_SIGNUP=true
|
|
216
|
+
ENABLE_EMAIL_VERIFICATION=true
|
|
217
|
+
ENABLE_PASSKEY=true
|
|
218
|
+
ENABLE_EMAIL_OTP=true
|
|
219
|
+
ENABLE_PASSWORD=false
|
|
220
|
+
ENABLE_ORGANIZATIONS=true
|
|
221
|
+
ENABLE_ADMIN=true
|
|
222
|
+
VITE_ENABLE_FILE_UPLOADS=true
|
|
223
|
+
DISABLE_EMAIL_STATUS_CHECK=false
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
## Environment-Specific Configuration
|
|
227
|
+
|
|
228
|
+
### Development
|
|
229
|
+
|
|
230
|
+
```bash title=".env.development"
|
|
231
|
+
VITE_QUICKBACK_API_URL=http://localhost:8787
|
|
232
|
+
VITE_ACCOUNT_APP_URL=http://localhost:5173
|
|
233
|
+
VITE_QUICKBACK_APP_URL=http://localhost:3000
|
|
234
|
+
DISABLE_EMAIL_STATUS_CHECK=true
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### Staging
|
|
238
|
+
|
|
239
|
+
```bash title=".env.staging"
|
|
240
|
+
VITE_QUICKBACK_API_URL=https://api-staging.example.com
|
|
241
|
+
VITE_ACCOUNT_APP_URL=https://account-staging.example.com
|
|
242
|
+
VITE_QUICKBACK_APP_URL=https://app-staging.example.com
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### Production
|
|
246
|
+
|
|
247
|
+
```bash title=".env.production"
|
|
248
|
+
VITE_QUICKBACK_API_URL=https://api.example.com
|
|
249
|
+
VITE_ACCOUNT_APP_URL=https://account.example.com
|
|
250
|
+
VITE_QUICKBACK_APP_URL=https://app.example.com
|
|
251
|
+
DISABLE_EMAIL_STATUS_CHECK=false
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
## Cloudflare Pages Setup
|
|
255
|
+
|
|
256
|
+
When deploying to Cloudflare Pages, set environment variables in the dashboard:
|
|
257
|
+
|
|
258
|
+
1. Go to **Settings** → **Environment Variables**
|
|
259
|
+
2. Add each `VITE_*` variable
|
|
260
|
+
3. Separate values for **Production** and **Preview** branches
|
|
261
|
+
|
|
262
|
+
> **Build Variables**
|
|
263
|
+
>
|
|
264
|
+
> Vite environment variables are baked into the build at **build time**, not runtime. Changing a variable requires a rebuild and redeploy.
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
## Wrangler Configuration
|
|
268
|
+
|
|
269
|
+
For `wrangler dev` and `wrangler deploy`, add variables to `wrangler.toml`:
|
|
270
|
+
|
|
271
|
+
```toml title="wrangler.toml"
|
|
272
|
+
[env.production.vars]
|
|
273
|
+
VITE_QUICKBACK_API_URL = "https://api.example.com"
|
|
274
|
+
VITE_ACCOUNT_APP_URL = "https://account.example.com"
|
|
275
|
+
VITE_APP_NAME = "My App"
|
|
276
|
+
# ... other variables
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
Or use `.dev.vars` for local development (git-ignored):
|
|
280
|
+
|
|
281
|
+
```bash title=".dev.vars"
|
|
282
|
+
VITE_QUICKBACK_API_URL=http://localhost:8787
|
|
283
|
+
VITE_ACCOUNT_APP_URL=http://localhost:5173
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
## Runtime Configuration
|
|
287
|
+
|
|
288
|
+
Some values can be overridden at runtime using the config API:
|
|
289
|
+
|
|
290
|
+
```ts
|
|
291
|
+
import { setAppConfig } from '@/config/app';
|
|
292
|
+
|
|
293
|
+
setAppConfig({
|
|
294
|
+
name: 'My Custom App',
|
|
295
|
+
branding: {
|
|
296
|
+
primaryColor: '#ff6600',
|
|
297
|
+
logoUrl: '/custom-logo.png',
|
|
298
|
+
},
|
|
299
|
+
urls: {
|
|
300
|
+
base: 'https://account.custom.com',
|
|
301
|
+
app: 'https://app.custom.com',
|
|
302
|
+
},
|
|
303
|
+
});
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
> **Limitations**
|
|
307
|
+
>
|
|
308
|
+
> Runtime configuration only works for values consumed by the React application. Environment variables used during the Vite build process cannot be changed at runtime.
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
## Validation
|
|
312
|
+
|
|
313
|
+
The Account UI validates configuration on startup:
|
|
314
|
+
|
|
315
|
+
- **Missing VITE_QUICKBACK_API_URL**: Throws error
|
|
316
|
+
- **Invalid URLs**: Logs warning
|
|
317
|
+
- **Missing optional fields**: Uses defaults
|
|
318
|
+
|
|
319
|
+
Check the browser console for configuration warnings.
|
|
320
|
+
|
|
321
|
+
## Next Steps
|
|
322
|
+
|
|
323
|
+
- **[Feature Flags](/stack/account-ui/features)** - Detailed feature configuration
|
|
324
|
+
- **[Customization](/stack/account-ui/customization)** - Customize labels and messages
|
|
325
|
+
- **[Worker Setup](/stack/account-ui/worker)** - Deploy to Cloudflare
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Admin Panel
|
|
2
|
+
|
|
3
|
+
The admin panel provides a user management dashboard for administrators. It's part of the Account UI SPA — when enabled, the `/admin` route is included in the build.
|
|
4
|
+
|
|
5
|
+
## Enabling Admin
|
|
6
|
+
|
|
7
|
+
Set `auth.admin` to `true` in your account config:
|
|
8
|
+
|
|
9
|
+
```typescript title="quickback/quickback.config.ts"
|
|
10
|
+
account: {
|
|
11
|
+
auth: {
|
|
12
|
+
admin: true,
|
|
13
|
+
},
|
|
14
|
+
},
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
This does two things:
|
|
18
|
+
1. Includes admin route files in the Account SPA build (compile-time gating)
|
|
19
|
+
2. Ensures the Better Auth `admin` plugin is enabled on the backend
|
|
20
|
+
|
|
21
|
+
When `auth.admin` is `false` (the default), admin routes are excluded from the SPA bundle entirely — they don't exist in production.
|
|
22
|
+
|
|
23
|
+
## What It Can Do
|
|
24
|
+
|
|
25
|
+
- **View all users** — Paginated list with search
|
|
26
|
+
- **Create users** — Manually create accounts with email/password
|
|
27
|
+
- **Ban/unban users** — Suspend or reactivate user accounts
|
|
28
|
+
- **Reset passwords** — Generate password reset for any user
|
|
29
|
+
- **View sessions** — See active sessions for any user
|
|
30
|
+
|
|
31
|
+
## Access Control
|
|
32
|
+
|
|
33
|
+
The admin panel is restricted to users with `role: "admin"` on their Better Auth user record. Non-admin users are redirected away from `/admin`.
|
|
34
|
+
|
|
35
|
+
To grant admin access to a user, use the Better Auth admin API:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
curl -X POST https://api.example.com/admin/v1/set-role \
|
|
39
|
+
-H "Authorization: Bearer $TOKEN" \
|
|
40
|
+
-H "Content-Type: application/json" \
|
|
41
|
+
-d '{ "userId": "user_123", "role": "admin" }'
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Custom Admin Domain
|
|
45
|
+
|
|
46
|
+
Give the admin panel its own subdomain with `adminDomain`:
|
|
47
|
+
|
|
48
|
+
```typescript title="quickback/quickback.config.ts"
|
|
49
|
+
account: {
|
|
50
|
+
domain: "auth.example.com",
|
|
51
|
+
adminDomain: "admin.example.com",
|
|
52
|
+
auth: { password: true, admin: true },
|
|
53
|
+
},
|
|
54
|
+
trustedOrigins: [
|
|
55
|
+
"https://auth.example.com",
|
|
56
|
+
"https://admin.example.com",
|
|
57
|
+
],
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
The admin domain serves the same Account SPA at root (`/`). The SPA's client-side router handles showing the admin page at `admin.example.com/admin`. Authentication cookies are shared across subdomains automatically via [cross-subdomain cookie configuration](/compiler/config/domains#cross-subdomain-authentication).
|
|
61
|
+
|
|
62
|
+
## CMS Access Control
|
|
63
|
+
|
|
64
|
+
When both CMS and Account UI are enabled, the admin panel's profile page shows a "Go to CMS" button. You can restrict this to admin users only:
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
cms: { domain: "cms.example.com", access: "admin" },
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
With `access: "admin"`, non-admin users can't access the CMS at any layer: the link is hidden in Account UI, the SPA shell returns `403` before serving `index.html`, `/api/v1/schema` returns `403`, and the `custom_view` CRUD is locked to admins. See [CMS Connecting](/stack/cms/connecting#restrict-cms-access-to-admin-users-only) for the full enforcement model.
|
|
71
|
+
|
|
72
|
+
## Related
|
|
73
|
+
|
|
74
|
+
- [Configuration](/compiler/config) — `auth.admin` and `adminDomain` options
|
|
75
|
+
- [Multi-Domain Architecture](/compiler/config/domains) — Custom domains and hostname routing
|
|
76
|
+
- [Access Control](/compiler/definitions/access) — Role-based permissions in your API
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# API Key Management
|
|
2
|
+
|
|
3
|
+
Account UI provides an API key management interface for users to create, view, and revoke API keys.
|
|
4
|
+
|
|
5
|
+
## Creating API Keys
|
|
6
|
+
|
|
7
|
+
Users can create API keys with:
|
|
8
|
+
|
|
9
|
+
- Custom name/description
|
|
10
|
+
- Optional expiration date
|
|
11
|
+
- Scoped to the current organization
|
|
12
|
+
|
|
13
|
+
## Managing Keys
|
|
14
|
+
|
|
15
|
+
- View all active API keys
|
|
16
|
+
- See last-used timestamp
|
|
17
|
+
- Revoke individual keys
|
|
18
|
+
|
|
19
|
+
## Related
|
|
20
|
+
|
|
21
|
+
- [API Keys Auth](/stack/auth/api-keys) — Server-side API key authentication
|
|
22
|
+
- [Environment Variables](/stack/account-ui/environment-variables)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Avatars
|
|
2
|
+
|
|
3
|
+
When file uploads are enabled, Account UI provides avatar upload functionality.
|
|
4
|
+
|
|
5
|
+
## Enabling
|
|
6
|
+
|
|
7
|
+
In `quickback.config.ts`:
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
account: {
|
|
11
|
+
fileUploads: true,
|
|
12
|
+
// ...
|
|
13
|
+
}
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
The compiler emits `VITE_ENABLE_FILE_UPLOADS=true` into the Account SPA's
|
|
17
|
+
build env. For standalone Account UI deployments (built outside the
|
|
18
|
+
compiler), set `VITE_ENABLE_FILE_UPLOADS=true` in `.env` directly.
|
|
19
|
+
|
|
20
|
+
## Upload Flow
|
|
21
|
+
|
|
22
|
+
1. User clicks their profile picture
|
|
23
|
+
2. Image picker opens (supports JPG, PNG, WebP)
|
|
24
|
+
3. Image is cropped to square
|
|
25
|
+
4. Uploaded to R2/S3 storage
|
|
26
|
+
5. Profile updated with new avatar URL
|
|
27
|
+
|
|
28
|
+
## Requirements
|
|
29
|
+
|
|
30
|
+
- `account.fileUploads: true` (or `VITE_ENABLE_FILE_UPLOADS=true` for standalone)
|
|
31
|
+
- R2 bucket or S3-compatible storage configured
|
|
32
|
+
- Upload endpoints available in your API
|
|
33
|
+
|
|
34
|
+
## Related
|
|
35
|
+
|
|
36
|
+
- [R2 Storage](/stack/storage/r2) — File storage setup
|
|
37
|
+
- [Environment Variables](/stack/account-ui/environment-variables)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# CLI Authorization
|
|
2
|
+
|
|
3
|
+
Account UI includes a device authorization page that allows users to approve CLI login requests.
|
|
4
|
+
|
|
5
|
+
## How It Works
|
|
6
|
+
|
|
7
|
+
1. User runs `quickback login` in the CLI
|
|
8
|
+
2. CLI displays a URL and user code
|
|
9
|
+
3. User opens the URL in their browser
|
|
10
|
+
4. Account UI shows the authorization page with the device code
|
|
11
|
+
5. User confirms the code matches and approves
|
|
12
|
+
6. CLI receives the authentication token
|
|
13
|
+
|
|
14
|
+
## Configuration
|
|
15
|
+
|
|
16
|
+
The CLI authorization page is always available when the Account UI is deployed. No additional configuration is needed.
|
|
17
|
+
|
|
18
|
+
## Related
|
|
19
|
+
|
|
20
|
+
- [Device Auth](/stack/auth/device-auth) — Server-side device auth flow
|
|
21
|
+
- [CLI Reference](/compiler/cloud-compiler/cli) — CLI commands
|