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
{{ message }}
Repository navigation
Commit efcaf75
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+16-6Lines changed: 16 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,14 @@
1
1
# Void
2
2
3
-
Full-stack apps with [Vite](https://vite.dev), running on Cloudflare Workers.
3
+
Build and deploy full-stack apps with [Vite](https://vite.dev), running on Cloudflare Workers.
4
4
5
-
Build APIs and server-rendered pages with typed access to databases, storage, and AI. Void detects the resources your app uses and provisions them when you deploy. Use React, Vue, Svelte, Solid, or a [supported framework](https://void.cloud/integrations/frameworks/overview).
5
+
Void brings together three open-source tools for you and your coding agents:
6
+
7
+
-**Void SDK:** Build your server and client together with file-based API routes, server-rendered pages, and typed APIs for databases, storage, and AI. Carry types from database queries to the UI.
8
+
-**Void CLI:** Build your app, provision the Cloudflare resources it uses, apply migrations, and deploy with one command. Manage resources, inspect logs, and roll back through the same CLI.
9
+
-**Void Platform:** Install a shared deployment environment in your Cloudflare account for your team or customers, with access controls, resource limits, and usage reporting.
10
+
11
+
The SDK's features are optional and composable. Use React, Vue, Svelte, or Solid for Void pages, or keep a [supported application framework](https://void.cloud/integrations/frameworks/overview) for routing and rendering while Void handles resource APIs, migrations, and deployment.
6
12
7
13
## Getting Started
8
14
@@ -20,19 +26,23 @@ Choose your UI framework and starter, then select Cloudflare to deploy to your a
20
26
npx void deploy
21
27
```
22
28
23
-
Void builds the app, provisions resources, applies database migrations, and prints your deployed URL. Follow the [Quickstart](https://void.cloud/guide/quickstart) to explore your app or add Void to an existing Vite project.
29
+
Void builds the app, provisions resources, applies database migrations, and prints your deployed URL. Follow the [Quickstart](https://void.cloud/guide/quickstart) for your first app or to add Void to an existing Vite project.
30
+
31
+
To deploy to a team platform, run `npx void connect <url>` first, then use the same deploy command. See [Install a Void Platform](https://void.cloud/guide/self-hosted-platform) to host one in your Cloudflare account or customize its open-source runtime.
24
32
25
33
## Documentation
26
34
27
-
-[How Void works](https://void.cloud/guide/)
35
+
Read the [Void documentation](https://void.cloud) online or use the Markdown guides and references in `node_modules/void/docs/`, included with the `void` package.
36
+
37
+
`void init` adds a minimal `AGENTS.md` in new projects and asks before changing instructions in existing projects. It also links bundled skills for detected coding agents.
38
+
28
39
-[Server routes](https://void.cloud/guide/server-routing) and [pages](https://void.cloud/guide/pages-routing/overview)
29
40
-[Database](https://void.cloud/guide/database) and [type safety](https://void.cloud/guide/type-safety)
Teams can [install a Void platform](https://void.cloud/guide/self-hosted-platform) in a shared Cloudflare account. The framework, CLI, and platform source are included in this repository.
Staging CI on main also runs the production schema-compatibility gate, so its failures are caught
170
178
before tagging a release. The job copies the candidate's `.github/scripts/schema-compat-tests.ts` runner
171
179
before checking out the deployed revision. It runs every deployed API test file against its own
@@ -221,6 +229,14 @@ utility and Bash; it has no Python or native npm dependency.
221
229
222
230
## Browser readiness and Windows CI
223
231
232
+
Pages scroll regressions run in Chromium by default. On a machine with Playwright WebKit support,
233
+
run the same document navigation, reload, SPA navigation, and suspended-render cases in WebKit:
234
+
235
+
```sh
236
+
vp exec playwright install webkit
237
+
VOID_TEST_BROWSER=webkit vp test run packages/react/test/integration packages/vue/test/integration packages/svelte/test/integration packages/solid/test/integration -t 'restores.*scroll'
238
+
```
239
+
224
240
Use `waitForIslandsHydrated` from `test/browser-helpers.ts` before asserting island state or
225
241
interacting with islands. Pass the expected minimum count when checking a multi-island fixture.
226
242
Each island imports and hydrates independently, so a selector matching one hydrated island does
@@ -308,7 +324,7 @@ Use the intended test account rather than an account name embedded in a script.
308
324
- setting `CLOUDFLARE_ACCOUNT_ID` in the current shell.
309
325
310
326
When a version has no preview URL, also set `CLOUDFLARE_WORKERS_SUBDOMAIN` to the account's
311
-
workers.dev subdomain. For `https://my-worker.my-team.workers.dev`, the value is `my-team`. The
327
+
workers.dev subdomain. For [`https://my-worker.my-team.workers.dev`](https://my-worker.my-team.workers.dev), the value is `my-team`. The
312
328
account name shown in the dashboard is not necessarily the workers.dev subdomain.
313
329
314
330
Never commit account IDs, resource IDs, API tokens, or Access credentials. CI should receive them
0 commit comments