Next.js Vercel Todo App .cursorrules prompt file

100

Mckay Wrigley

Save

Saved

NEW

Next.js Vercel Todo App .cursorrules prompt file

Project Instructions

Use the project specification and guidelines as you build the todo app.

Write the complete code for every step. Do not get lazy.

Your goal is to completely finish whatever the user asks for.

Overview

Todo app is a web app that allows you to manage your todos.

Tech Stack

Frontend: Next.js, Tailwind, Shadcn, Framer Motion
Backend: Postgres, Supabase, Drizzle ORM, Server Actions
Auth: Clerk
Payments: Stripe
Deployment: Vercel

Project Structure

General Structure

actions - Server actions
db - Database related actions
Other actions
app - Next.js app router
api - API routes
route - An example route (each of these are only if needed)
- _components - One-off components for the route
- layout.tsx - Layout for the route
- page.tsx - Page for the route
components - Shared components
ui - UI components
utilities - Utility components
db - Database
migrations - Database migrations (you never have to do anything in here)
queries - Database queries
schema - Database schemas
lib - Library code
hooks - Custom hooks
prompts - Prompt files
public - Static assets
types - Type definitions

Project Specific Structure

Rules

Follow these rules when building the project.

General Rules

Use @ to import anything from the project unless otherwise specified
Use kebab case for all files and folders unless otherwise specified

Env Rules

If you update environment variables, update the .env.example file
All environment variables should go in .env.local
Do not expose environment variables to the frontend
Use NEXT_PUBLIC_ prefix for environment variables that need to be accessed from the frontend
You may import environment variables in server actions and components by using process.env.VARIABLE_NAME

Type Rules

Follow these rules when working with types.

When importing types, use @/types
Name files like example-types.ts
All types should go in types
Make sure to export the types in types/index.ts
Prefer interfaces over type aliases
If referring to db types, use @/db/schema such as SelectTodo from todos-schema.ts

An example of a type:

types/actions-types.ts

export type ActionState`<T>` = {  isSuccess: boolean  message: string  data?: T}

And exporting it:

types/index.ts

export * from "./actions-types"

Frontend Rules

Follow these rules when working on the frontend.

It uses Next.js, Tailwind, Shadcn, and Framer Motion.

General Rules

Use lucide-react for icons

Components

Use divs instead of other html tags unless otherwise specified
Separate the main parts of a component's html with an extra blank line for visual spacing
Use actions, not queries, in the app
Always tag a component with either use server or use client at the top, including layouts and pages

Organization

All components be named using kebab case like example-component.tsx unless otherwise specified
Put components in /_components in the route if one-off components
Put components in /components from the root if shared components

Data Fetching

Fetch data in server components and pass down as props to client components such as initialTodos
Use server actions from /actions to mutate data

Server Components

Use "use server" at the top of the file
Implement Suspense for asynchronous data fetching
Use a separate fetcher component for data loading (see example below)

Example of a server page:

"use server"import { Suspense } from "react"import { SomeAction } from "@/actions/some-actions"import SomeComponent from "./_components/some-component"import SomeSkeleton from "./_components/some-skeleton"export default async function ExampleServerPage({  params}: {  params: { id: string }}) {  return (    `<Suspense fallback={<SomeSkeleton className="some-class" />`}>      `<SomeComponentFetcher id={params.id} />`    `</Suspense>`  )}async function SomeComponentFetcher({ id }: { id: string }) {  const { data } = await SomeAction(id)  return (    `<SomeComponent className="some-class" initialData={data || []} id={id} />`  )}

Example of a server component:

"use server"interface ExampleServerComponentProps {  // Your props here}export async function ExampleServerComponent({  props}: ExampleServerComponentProps) {  // Your code here}

Client Components

Use "use client" at the top of the file

Example of a client page:

"use client"export default function ExampleClientPage() {  // Your code here}

Example of a client component:

"use client"interface ExampleClientComponentProps {  // Your props here}export default function ExampleClientComponent({  props}: ExampleClientComponentProps) {  // Your code here}

Backend Rules

Follow these rules when working on the backend.

It uses Postgres, Supabase, Drizzle ORM, and Server Actions.

General Rules

Never generate migrations. You do not have to do anything in the db/migrations folder inluding migrations and metadata. Ignore it.

Organization

Schemas

When importing schemas, use @/db/schema
Name files like example-schema.ts
All schemas should go in db/schema
Make sure to export the schema in db/schema/index.ts
Make sure to add the schema to the schema object in db/db.ts
If using a userId, always use userId: text("user_id").notNull()
Always include createdAt and updatedAt columns in all tables
Make sure to cascade delete when necessary
Use enums for columns that have a limited set of possible values such as:

import { pgEnum } from "drizzle-orm/pg-core"export const membershipEnum = pgEnum("membership", ["free", "pro"])membership: membershipEnum("membership").notNull().default("free")

Example of a schema:

db/schema/todos-schema.ts

import { boolean, pgTable, text, timestamp, uuid } from "drizzle-orm/pg-core"export const todosTable = pgTable("todos", {  id: uuid("id").defaultRandom().primaryKey(),  userId: text("user_id").notNull(),  content: text("content").notNull(),  completed: boolean("completed").default(false).notNull(),  createdAt: timestamp("created_at").defaultNow().notNull(),  updatedAt: timestamp("updated_at")    .defaultNow()    .notNull()    .$onUpdate(() => new Date())})export type InsertTodo = typeof todosTable.$inferInsertexport type SelectTodo = typeof todosTable.$inferSelect

And exporting it:

db/schema/index.ts

export * from "./todos-schema"

And adding it to the schema in db/db.ts:

db/db.ts

import { todosTable } from "@/db/schema"const schema = {  todos: todosTable}

And a more complex schema:

import { pgTable, text, timestamp, uuid } from "drizzle-orm/pg-core"export const chatsTable = pgTable("chats", {  id: uuid("id").defaultRandom().primaryKey(),  userId: text("user_id").notNull(),  name: text("name").notNull(),  createdAt: timestamp("created_at").defaultNow().notNull(),  updatedAt: timestamp("updated_at")    .defaultNow()    .notNull()    .$onUpdate(() => new Date())})export type InsertChat = typeof chatsTable.$inferInsertexport type SelectChat = typeof chatsTable.$inferSelect

import { pgEnum, pgTable, text, timestamp, uuid } from "drizzle-orm/pg-core"import { chatsTable } from "./chats-schema"export const roleEnum = pgEnum("role", ["assistant", "user"])export const messagesTable = pgTable("messages", {  id: uuid("id").defaultRandom().primaryKey(),  chatId: uuid("chat_id")    .references(() => chatsTable.id, { onDelete: "cascade" })    .notNull(),  content: text("content").notNull(),  role: roleEnum("role").notNull(),  createdAt: timestamp("created_at").defaultNow().notNull(),  updatedAt: timestamp("updated_at")    .defaultNow()    .notNull()    .$onUpdate(() => new Date())})export type InsertMessage = typeof messagesTable.$inferInsertexport type SelectMessage = typeof messagesTable.$inferSelect

And exporting it:

db/schema/index.ts

export * from "./chats-schema"export * from "./messages-schema"

And adding it to the schema in db/db.ts:

db/db.ts

import { chatsTable, messagesTable } from "@/db/schema"const schema = {  chats: chatsTable,  messages: messagesTable}

Queries

When importing queries, use @/db/queries
Name files like example-queries.ts
All queries should go in db/queries
Queries have 'use server' at the top
Only write the needed queries
Do not use explicit returns in queries
Sort in CRUD order: Create, Read, Update, Delete

Example of a query:

db/queries/todos-queries.ts

"use server"import { db } from "@/db/db"import { InsertTodo, todosTable } from "@/db/schema"import { eq } from "drizzle-orm"export const createTodo = async (data: InsertTodo) => {  try {    const [newTodo] = await db.insert(todosTable).values(data).returning()    return newTodo  } catch (error) {    console.error("Error creating todo:", error)    throw new Error("Failed to create todo")  }}export const getTodos = async (userId: string) => {  try {    return db.query.todos.findMany({      where: eq(todosTable.userId, userId)    })  } catch (error) {    console.error("Error getting todos:", error)    throw new Error("Failed to get todos")  }}

Server Actions

When importing actions, use @/actions or @/actions/db if db related
DB related actions should go in the actions/db folder
Other actions should go in the actions folder
Name files like example-actions.ts
All actions should go in the actions folder
Always use revalidatePath("/") after a successful action
Only write the needed actions
Return an ActionState with the needed data type from actions
Include Action at the end of function names Ex: exampleFunction -> exampleFunctionAction
Actions should return a Promise<ActionState<T>>
Actions use queries from db/queries
Sort in CRUD order: Create, Read, Update, Delete

export type ActionState`<T>` = {  isSuccess: boolean  message: string  data?: T}

Example of an action:

actions/db/todos-actions.ts

"use server"import { createTodo, getTodos } from "@/db/queries/todos-queries"import { InsertTodo, SelectTodo } from "@/db/schema/todos-schema"import { ActionState } from "@/types"import { revalidatePath } from "next/cache"export async function createTodoAction(  todo: InsertTodo): Promise`<ActionState<SelectTodo>`> {  try {    const newTodo = await createTodo(todo)    revalidatePath("/")    return {      isSuccess: true,      message: "Todo created successfully",      data: newTodo    }  } catch (error) {    console.error("Error creating todo:", error)    return { isSuccess: false, message: "Failed to create todo" }  }}export async function getTodosAction(  userId: string): Promise`<ActionState<SelectTodo[]>`> {  try {    const todos = await getTodos(userId)    return {      isSuccess: true,      message: "Todos retrieved successfully",      data: todos    }  } catch (error) {    console.error("Error getting todos:", error)    return { isSuccess: false, message: "Failed to get todos" }  }}

Auth Rules

Follow these rules when working on auth.

It uses Clerk for authentication.

General Rules

Import the auth helper with import { auth } from "@clerk/nextjs/server" in server components

Payments Rules

Follow these rules when working on payments.

It uses Stripe for payments.

stack:

Next.js Vercel Todo App .cursorrules prompt file

Mckay Wrigley

About .cursorrules prompt file

What you can build

TaskFlow: A task management web application providing users with the ability to create, update, and delete tasks using Next.js and Supabase for efficient real-time synchronization.
Stripe-Powered Invoicing System: A web app that allows freelancers to manage tasks and automatically generate invoices for completed work using Stripe for payment processing.
Secure Task Management-Lite: A simple task manager focused on privacy and security, leveraging Clerk for authentication to ensure only authorized users can access and modify their task data.
Team Task Collaboration Hub: An advanced to-do app for teams to manage projects collaboratively, featuring role-based permissions, real-time updates with Supabase, and engaging UI animations via Framer Motion.
Task Tracker Widget: A browser extension or small web widget that allows users to quickly add tasks on-the-go, synchronizing with a main to-do app using Drizzle ORM to handle background data transactions.
Personal Productivity Dashboard: An interactive dashboard integrating tasks with Stripe subscription payments for personal coach services, empowering users to achieve better work-life integration.
Scheduled Task Reminder App: A service with server-side Scheduler Actions that sends timely reminders about pending tasks via email or in-app notifications to ensure task completion.
Accessible Todo List App: A simplistic and accessible todo list application focusing on UI/UX designs using Tailwind and accessibility standards for users with disabilities.
Mobile Todo & Payment App: A mobile-first web app version of the todo app with integrated payments via Stripe for purchasing add-on task management features.
Data-Driven Task Insights: A backend analytics service providing insights into your task usage patterns, productivity peaks, and personalized suggestions using data from Postgres queries.
Customizable Kanban Board: An upgrade from a simple task list to a dynamic Kanban board layout, allowing users to visually organize tasks across customizable stages with Drizzle ORM-backed data persistence.
Family Task Organizer: A family-focused task management app that lets family members share and delegate tasks among each other, incorporating Clerk for easy user management.
SyncTask Between Devices: A cross-device synchronization app designed to keep task lists consistent between various user devices with Supabase real-time updates.
Framer Motion Task Animation Tool: A specialized tool or library catalog developed for the todo app to leverage Framer Motion animations in customizing task entry and completion animations.
Task Management Training App: A guided tutorial and simulated environment teaching productivity and task management techniques, accompanied by interactive task management exercises.

Benefits

Detailed folder structure to maintain organized code separation between components, schemas, actions, and queries.
Comprehensive instructions on data handling using Postgres, Supabase, and Drizzle ORM with specific file naming conventions and import paths for consistency.
Emphasis on server-side data fetching and mutations using actions, ensuring server components are used effectively with actions, suspense, and fallback components.

Synopsis

This prompt is ideal for developers building a todo app with Next.js and Supabase, offering a structured guide for implementing frontend and backend rules, database schemas, and server actions.

Overview of .cursorrules prompt

The .cursorrules file provides a comprehensive guide to building a todo app using specified technology stacks, both for frontend and backend development. It outlines the project's structure, including guidelines for server actions, database schemas, API routes, and UI components. The file includes detailed rules for managing environment variables, interacting with types, organizing code, and implementing both server and client components. It also specifies best practices for utilizing Next.js, integrating authentication with Clerk, managing payments with Stripe, and deploying with Vercel. The document emphasizes code organization, type usage, data fetching strategies, and provides examples of schema and query implementations.

Next.js Vercel Todo App .cursorrules prompt file

Next.js Vercel Todo App .cursorrules prompt file

Next.js Vercel Todo App .cursorrules prompt file

About .cursorrules prompt file

What you can build

Benefits

Synopsis

Overview of .cursorrules prompt

Tags

Next.js TypeScript Clerk Stripe Vercel Setup .cursorrules prompt file

ReactJS Front-End Developer .cursorrules prompt file

Tanstack Start TypeScript State Mgmt .cursorrules prompt file

Node React Tailwind Guide .cursorrules prompt file

Cursor AI TypeScript .cursorrules prompt file

.cursorrules file Cursor AI Python FastAPI API

Python FastAPI Scalable API .cursorrules prompt file

Flask-RESTful JWT RESTX .cursorrules prompt file

Cursor AI React TypeScript Shadcn UI .cursorrules prompt file

Next.js React TypeScript .cursorrules prompt file

Python Pytest Typer .cursorrules prompt file

Next.js Tailwind CSS Obsidian Plugin .cursorrules prompt file

Next.js TypeScript Clerk Stripe Vercel Setup .cursorrules prompt file

React TypeScript Care Project .cursorrules prompt file

Elixir Code Guidelines .cursorrules prompt file

.cursorrules file Cursor AI Python FastAPI API

SvelteKit TailwindCSS TypeScript .cursorrules prompt file

JavaScript TypeScript Code Quality .cursorrules prompt file

Plasticode Telegram API .cursorrules prompt file

ES Module Node.js Guidelines .cursorrules prompt file

Cursor Tip

Here is a quick example of leveraging the .cursorrules file (sys

Cursor Tip

Cursor Tip

Cursor Tip

Create a Chrome Extension Fast: Cursor AI Tutorial

Build ChatGPT with Python: Cursor AI Tutorial Guide

Build AI Voice Notes App: Cursor AI Tutorial Guide

Cursor AI Tutorial: Easy Loading Page with Shadcn Components