-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add cursor guideline and cursorruls
- Loading branch information
Showing
3 changed files
with
132 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
|
||
You are an expert in TypeScript, Node.js, Next.js 15 App Router, React, Shadcn UI, Radix UI and Tailwind. | ||
|
||
Code Style and Structure | ||
- Write concise, technical TypeScript code with accurate examples. | ||
- Use functional and declarative programming patterns; avoid classes. | ||
- Prefer iteration and modularization over code duplication. | ||
- Use descriptive variable names with auxiliary verbs (e.g., isLoading, hasError). | ||
- Structure files: exported component, subcomponents, helpers, static content, types. | ||
|
||
Naming Conventions | ||
- Use lowercase with dashes for directories (e.g., components/auth-wizard). | ||
- Favor named exports for components. | ||
|
||
TypeScript Usage | ||
- Use TypeScript for all code; prefer types over interfaces. | ||
- Avoid enums; use maps instead. | ||
- Use functional components with TypeScript types. | ||
|
||
Syntax and Formatting | ||
- Use the "function" keyword for pure functions. | ||
- Avoid unnecessary curly braces in conditionals; use concise syntax for simple statements. | ||
- Use declarative JSX. | ||
|
||
UI and Styling | ||
- Use Shadcn UI, Radix, and Tailwind for components and styling. | ||
- Implement responsive design with Tailwind CSS; use a mobile-first approach. | ||
|
||
Performance Optimization | ||
- Minimize 'use client', 'useEffect', and 'setState'; favor React Server Components (RSC). | ||
- Wrap client components in Suspense with fallback. | ||
- Use dynamic loading for non-critical components. | ||
- Optimize images: use WebP format, include size data, implement lazy loading. | ||
|
||
Key Conventions | ||
- Use 'nuqs' for URL search parameter state management. | ||
- Optimize Web Vitals (LCP, CLS, FID). | ||
- Limit 'use client': | ||
- Favor server components and Next.js SSR. | ||
- Use only for Web API access in small components. | ||
- Avoid for data fetching or state management. | ||
|
||
Follow Next.js 15 docs for Data Fetching, Rendering, and Routing. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Next.js 15 Boilerplate | ||
|
||
This is a [Next.js](https://nextjs.org/) 15 Boilerplate project base on [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). | ||
|
||
## Features | ||
|
||
- pnpm | ||
- chore | ||
- husky | ||
- lint-stage | ||
- prettier | ||
- commitlint | ||
- css: tailwindcss | ||
- UI Library: [shadcn/ui](https://ui.shadcn.com/) | ||
- bundle-analyzer: [@next/bundle-analyzer](https://www.npmjs.com/package/@next/bundle-analyzer) | ||
- logger: [pino](https://github.com/pinojs/pino) && development pretty logging [pino-pretty](https://github.com/pinojs/pino-pretty) | ||
- test: | ||
- [vitest](https://vitest.dev/) | ||
- [react testing library](https://testing-library.com/) | ||
- i18n(TBD) | ||
- [setting-tutorials](https://i18nexus.com/tutorials/nextjs/react-i18next) | ||
- [next-intl](https://github.com/amannn/next-intl) not compatible with turbo mode `Module not found: Can't resolve 'next-intl/config' ` | ||
- [next-international](https://github.com/QuiiBz/next-international) seems better, but not compatible with Not found page | ||
- Maybe the best choice is official Example: [app-dir-i18n-routing](https://github.com/vercel/next.js/tree/canary/examples/app-dir-i18n-routing) | ||
- Docker | ||
- Playwright: Write end-to-end tests like a pro or cypress | ||
- Github actions/CI | ||
- Turbo for task cache |