Skip to content

README.md

Latest commit

 

History

History
49 lines (30 loc) · 1.45 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.45 KB

A Collaborative Todo Sample - ZenStack v3 + Next.js + TanStack Query

This project is a collaborative todo app built with Next.js, Auth.js, TanStack Query, and ZenStack v3.

In this fictitious app, users can be invited to workspaces where they can collaborate on todos. Public todo lists are visible to all members in the workspace.

See a live deployment at: https://v3-sample-todo-nextjs.vercel.app/.

Features:

  • User signup/signin
  • Creating workspaces and inviting members
  • Data segregation and permission control

Running the sample:

  1. Setup a new PostgreSQL database

    You can launch a PostgreSQL instance locally, or create one from a hoster like Supabase. Create a new database for this app, and set the connection string in .env file.

  2. Install dependencies

    npm install

  3. Configure environment variables

    Copy the .env.example file to .env and set the values for your environment. Github related variables can be left empty if you don't need GitHub OAuth login.

  4. Generate server and client-side code from model

    npm run generate

  5. Synchronize database schema

    npm run db:push

  6. Start dev server

    npm run dev

For more information on using ZenStack, visit https://zenstack.dev/v3.