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 }}
This repository was archived by the owner on Oct 22, 2025. It is now read-only.
@@ -83,28 +83,28 @@ This ensures imports resolve correctly across different build environments and p
83
83
- UPPER_CASE for constants
84
84
- Use `#` prefix for private class members (not `private` keyword)
85
85
-**Error Handling:**
86
-
- Extend from `ActorError` base class
86
+
- Extend from `WorkerError` base class
87
87
- Use `UserError` for client-safe errors
88
88
- Use `InternalError` for internal errors
89
89
- Don't try to fix type issues by casting to unknown or any. If you need to do this, then stop and ask me to manually intervene.
90
90
- Write log messages in lowercase
91
-
- Instead of returning raw HTTP responses with c.json, use or write an error in packages/actor-core/src/actor/errors.ts and throw that instead. The middleware will automatically serialize the response for you.
91
+
- Instead of returning raw HTTP responses with c.json, use or write an error in packages/rivetkit/src/worker/errors.ts and throw that instead. The middleware will automatically serialize the response for you.
92
92
93
93
## Project Structure
94
94
95
95
- Monorepo with Yarn workspaces and Turborepo
96
-
- Core code in `packages/actor-core/`
96
+
- Core code in `packages/rivetkit/`
97
97
- Platform implementations in `packages/platforms/`
98
98
- Driver implementations in `packages/drivers/`
99
99
100
100
## Development Notes
101
101
102
-
- Prefer classes over factory functions
102
+
- Prefer classes over fworkery functions
103
103
- Use zod for runtime type validation
104
104
- Use `assertUnreachable(x: never)` for exhaustive type checking in switch statements
105
105
- Follow existing patterns for P2P networking
106
106
- Add proper JSDoc comments for public APIs
107
107
- Ensure proper error handling with descriptive messages
108
108
- Run `yarn check-types` regularly during development to catch type errors early. Prefer `yarn check-types` instead of `yarn build`.
109
109
- Use `tsx` CLI to execute TypeScript scripts directly (e.g., `tsx script.ts` instead of `node script.js`).
@@ -81,7 +81,7 @@ No servers to manage. Your code runs on-demand and scales automatically with usa
81
81
82
82
## Examples
83
83
84
-
Browse snippets for how to use ActorCore with different use cases.
84
+
Browse snippets for how to use RivetKit with different use cases.
85
85
86
86
| Example | Actor (JavaScript) | Actor (SQLite) | Frontend (React) |
87
87
|---------|------------|--------|-------|
@@ -100,33 +100,33 @@ _SQLite will be available in June. We’re working on publishing full examples r
100
100
101
101
## Runs On Your Stack
102
102
103
-
Deploy ActorCore anywhere - from serverless platforms to your own infrastructure. Don't see the runtime you want? [Add your own](http://localhost:3000/drivers/build).
103
+
Deploy RivetKit anywhere - from serverless platforms to your own infrastructure. Don't see the runtime you want? [Add your own](http://localhost:3000/drivers/build).
- <imgsrc="docs/images/platforms/vercel.svg"height="16"alt="Vercel" />  [Vercel](https://github.com/rivet-gg/actor-core/issues/897)*(On The Roadmap)*
111
-
- <imgsrc="docs/images/platforms/aws-lambda.svg"height="16"alt="AWS Lambda" />  [AWS Lambda](https://github.com/rivet-gg/actor-core/issues/898)*(On The Roadmap)*
- <imgsrc="docs/images/platforms/vercel.svg"height="16"alt="Vercel" />  [Vercel](https://github.com/rivet-gg/rivetkit/issues/897)*(On The Roadmap)*
111
+
- <imgsrc="docs/images/platforms/aws-lambda.svg"height="16"alt="AWS Lambda" />  [AWS Lambda](https://github.com/rivet-gg/rivetkit/issues/898)*(On The Roadmap)*
Seamlessly integrate ActorCore with your favorite frameworks, languages, and tools. Don't see what you need? [Request an integration](https://github.com/rivet-gg/actor-core/issues/new).
124
+
Seamlessly integrate RivetKit with your favorite frameworks, languages, and tools. Don't see what you need? [Request an integration](https://github.com/rivet-gg/rivetkit/issues/new).
- <imgsrc="docs/images/integrations/better-auth.svg"height="16"alt="Better Auth" />  [Better Auth](https://github.com/rivet-gg/actor-core/issues/906)*(On The Roadmap)*
142
-
- <imgsrc="docs/images/platforms/vercel.svg"height="16"alt="AI SDK" />  [AI SDK](https://github.com/rivet-gg/actor-core/issues/907)*(On The Roadmap)*
141
+
- <imgsrc="docs/images/integrations/better-auth.svg"height="16"alt="Better Auth" />  [Better Auth](https://github.com/rivet-gg/rivetkit/issues/906)*(On The Roadmap)*
142
+
- <imgsrc="docs/images/platforms/vercel.svg"height="16"alt="AI SDK" />  [AI SDK](https://github.com/rivet-gg/rivetkit/issues/907)*(On The Roadmap)*
143
143
144
144
### Local-First Sync
145
-
- <imgsrc="docs/images/integrations/livestore.svg"height="16"alt="LiveStore" />  [LiveStore](https://github.com/rivet-gg/actor-core/issues/908)*(Available In June)*
- <imgsrc="docs/images/integrations/livestore.svg"height="16"alt="LiveStore" />  [LiveStore](https://github.com/rivet-gg/rivetkit/issues/908)*(Available In June)*
<summary><strong>How is ActorCore different than Rivet Actors?</strong></summary>
171
+
<summary><strong>How is RivetKit different than Rivet Actors?</strong></summary>
172
172
173
-
ActorCore is a framework written in TypeScript that provides high-level functionality. Rivet is an open-source serverless platform written in Rust with features tailored for stateful serverless.
173
+
RivetKit is a framework written in TypeScript that provides high-level functionality. Rivet is an open-source serverless platform written in Rust with features tailored for stateful serverless.
174
174
175
-
You can think of it as ActorCore is to Rivet as Next.js is to Vercel.
175
+
You can think of it as RivetKit is to Rivet as Next.js is to Vercel.
176
176
177
-
While Rivet is the primary maintainer of ActorCore, we intend for this to be community driven.
177
+
While Rivet is the primary maintainer of RivetKit, we intend for this to be community driven.
178
178
</details>
179
179
180
180
<details>
@@ -192,7 +192,7 @@ Sometimes it makes sense to use stateless serverless to make requests to multipl
192
192
</details>
193
193
194
194
<details>
195
-
<summary><strong>How does ActorCore achieve huge performance gains?</strong></summary>
195
+
<summary><strong>How does RivetKit achieve huge performance gains?</strong></summary>
196
196
197
197
By storing state in memory and flushing to a persistence layer, we can serve requests instantly instead of waiting for a round trip to the database. There are additional optimizations that can be made around your state to tune the durability of it.
198
198
@@ -225,12 +225,12 @@ Yes, but only as much as storing data in a single database row does. We're worki
225
225
Things are cooking! Check out our [blog post](https://rivet.gg/blog/2025-03-23-what-would-a-w3c-standard-look-like-for-stateful-serverless-) about what a W3C standard for stateful serverless might look like and [the awesome people who are collaborating on this](https://x.com/threepointone/status/1903579571028390038).
226
226
</details>
227
227
228
-
Have more questions? Join our [Discord](https://discord.gg/rivet) or go to [GitHub Discussions](https://github.com/rivet-gg/actor-core/discussions).
228
+
Have more questions? Join our [Discord](https://discord.gg/rivet) or go to [GitHub Discussions](https://github.com/rivet-gg/rivetkit/discussions).
229
229
230
230
## Roadmap For 2025
231
231
232
232
We ship fast, so we want to share what you can expect to see before the end of the year.
233
-
Help shape our roadmap by [creating issues](https://github.com/rivet-gg/actor-core/issues) and [joining our Discord](https://rivet.gg/discord).
233
+
Help shape our roadmap by [creating issues](https://github.com/rivet-gg/rivetkit/issues) and [joining our Discord](https://rivet.gg/discord).
234
234
235
235
-[ ] SQLite Support
236
236
-[ ] SQLite in Studio
@@ -260,13 +260,11 @@ Help shape our roadmap by [creating issues](https://github.com/rivet-gg/actor-co
0 commit comments