zenstack 0.3.0 → 0.3.2

package/README.md

@@ -7,7 +7,7 @@
     <a href="https://twitter.com/intent/tweet?text=Wow%20%40zenstackhq">
         <img src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fzenstackhq%2Fzenstack">
     </a>
-    <a href="https://discord.gg/6HhebQynfz">
+    <a href="https://go.zenstack.dev/chat">
         <img src="https://img.shields.io/discord/1035538056146595961">
     </a>
     <a href="https://github.com/zenstackhq/zenstack/blob/main/LICENSE">
@@ -15,21 +15,19 @@
     </a>
 </div>
 
-## What is ZenStack?
+## 📣 Our Discord Server is Live
+
+[JOIN US](https://go.zenstack.dev/chat) to chat about questions, bugs, plans, or anything off the top of your head.
 
-ZenStack is a toolkit for simplifying full-stack development with Node.js web frameworks like [Next.js](https://nextjs.org/), [Nuxt.js](https://nuxtjs.org/) <img src="https://img.shields.io/badge/-Coming%20Soon-lightgray" height="12" align="top">, and [SvelteKit](https://kit.svelte.dev/) <img src="https://img.shields.io/badge/-Coming%20Soon-lightgray" height="12" align="top">, using Typescript language.
+## What is ZenStack?
 
-Thanks to the increasing power of frameworks, building a complex web app within one unified framework is becoming more practical than ever. However, you'll still need to spend a significant amount of energy designing and building up your app's server-side part.
+[![ZenStack Full-stack Development Toolkit Introduction](https://cdn.loom.com/sessions/thumbnails/76ba1308fb734af993765a6696b62c96-1668251534738-with-play.gif)](https://www.loom.com/share/76ba1308fb734af993765a6696b62c96)
 
-Things that make you stressed include:
+ZenStack is a toolkit for modeling data and access policies in full-stack development with [Next.js](https://nextjs.org/) and Typescript.
 
--   What kind of API to use? RESTful or GraphQL?
--   How to model your data and map the model to both source code and database (ORM)?
--   How to implement CRUD operations? Manually construct it or use a generator?
--   How to evolve your data model?
--   How to authenticate users and authorize their requests?
+Next.js is an excellent full-stack framework. However, building the backend part of a web app is still quite challenging. For example, implementing CRUD services efficiently and securely is tricky and not fun.
 
-ZenStack aims to simplify these tasks by providing:
+ZenStack simplifies it by providing:
 
 -   An intuitive data modeling language for defining data types, relations, and access policies
 
@@ -60,7 +58,7 @@ model Post {
 }
 ```
 
--   Auto-generated CRUD services and strongly typed front-end library
+-   Auto-generated CRUD services and strongly typed React hooks
 
 ```jsx
 // React example
@@ -77,26 +75,24 @@ return (
 );
 ```
 
-Since CRUD APIs are automatically generated with access policies injected, you can safely implement most of your business logic in your front-end code. Read operations never return data that's not supposed to be visible to the current user, and writes will be rejected if unauthorized. The generated front-end library also supports nested writes, allowing you to make a batch of creates/updates atomically, eliminating the need for explicitly using a transaction.
+Since CRUD APIs are automatically generated with access policies injected, you can safely implement most of your business logic in your front-end code. Read operations never return data that's not supposed to be visible to the current user, and writes will be rejected if unauthorized.
 
-ZenStack is heavily inspired and built over [Prisma](https://www.prisma.io) ORM, which is, in our opinion, the best ORM toolkit in the market. Familiarity with Prisma should make it easy to pick up ZenStack, but it's not a prerequisite since the modeling language is intuitive and the development workflow is straightforward.
+ZenStack is heavily inspired and built above [Prisma](https://www.prisma.io) ORM, which is, in our opinion, the best ORM toolkit in the market. Familiarity with Prisma should make it easy to pick up ZenStack, but it's not a prerequisite since the modeling language is intuitive and the development workflow is straightforward.
 
 ## Getting started
 
-### [For Next.js](docs/get-started/next-js.md)
-
-### For Nuxt.js <img src="https://img.shields.io/badge/-Coming%20Soon-lightgray" height="12" align="top">
+[A step by step guide for getting started](docs/get-started/next-js.md)
 
-### For SvelteKit <img src="https://img.shields.io/badge/-Coming%20Soon-lightgray" height="12" align="top">
+[A complete sample with a collaborative todo app](https://github.com/zenstackhq/zenstack/tree/main/samples/todo)
 
 ## How does it work?
 
 ZenStack has four essential responsibilities:
 
-1. Modeling data and mapping the model to DB schema and program types
+1. Modeling data and mapping the model to DB schema and programmable client library
 1. Integrating with authentication
 1. Generating CRUD APIs and enforcing data access policies
-1. Providing type-safe client CRUD library
+1. Providing type-safe React hooks
 
 Let's briefly go through each of them in this section.
 
@@ -158,9 +154,11 @@ When client code sends a query to list all `Post`s, ZenStack's generated code in
 
 Similar procedures are applied to write operations and more complex queries involving nested reads and writes. To ensure good performance, ZenStack generates conditions statically, so it doesn't need to introspect ZModel at runtime. The engine also makes the best effort to push down policy constraints to the database to avoid fetching data unnecessarily and discarding afterward.
 
-Please **beware** that policy checking is only applied when data access is done using the generated client-side hooks or, equivalently, the RESTful API. If you use `service.db` to access the database directly from server-side code, policies are bypassed, and you have to do all necessary checking by yourself. We've planned to add helper functions for "injecting" the policy checking on the server side in the future.
+Please **BEWARE** that policy checking is only applied when data access is done using the generated client-side hooks or, equivalently, the RESTful API. If you use `service.db` to access the database directly from server-side code, policies are bypassed, and you have to do all necessary checking by yourself. We've planned to add helper functions for "injecting" the policy checking on the server side in the future.
 
-### Type-safe client library
+### Type-safe React hooks
+
+Strongly-typed React hooks are generated for CRUD operations, saving the need to write boilerplate code.
 
 Thanks to Prisma's power, ZenStack generates accurate Typescript types for your data models:
 
@@ -174,11 +172,7 @@ The cool thing is that the generated types are shared between client-side and se
 
 ### Client-side
 
-#### For Next.js
-
-The generated CRUD services should be mounted at `/api/zenstack` route. React hooks are generated for calling these services without explicitly writing Http requests.
-
-The following hooks methods are generated:
+The generated CRUD services should be mounted at `/api/zenstack` route. The following React hooks are generated for each data model:
 
 -   find: listing entities with filtering, ordering, pagination, and nested relations
 
@@ -276,5 +270,5 @@ export const getServerSideProps: GetServerSideProps = async () => {
 
 ## Reach out to us for issues, feedback and ideas!
 
-[Discord](https://discord.gg/dbuC9ZWc) [Twitter](https://twitter.com/zenstackhq)
-[Discussions](../discussions) [Issues](../issues)
+[Discord](https://go.zenstack.dev/chat) | [Twitter](https://twitter.com/zenstackhq) |
+[Discussions](../discussions) | [Issues](../issues)