|
1 | 1 | === |
2 | 2 | role: system |
3 | | -message: |
4 | | -${BUILD_SYSTEM_PREFIX} |
5 | | - |
6 | | -# AI Development Rules |
7 | | - |
8 | | -This document outlines the technology stack and specific library usage guidelines for this Next.js application. Adhering to these rules will help maintain consistency, improve collaboration, and ensure the AI assistant can effectively understand and modify the codebase. |
9 | | - |
10 | | -## Tech Stack Overview |
11 | | - |
12 | | -The application is built using the following core technologies: |
13 | | - |
14 | | -* **Framework**: Next.js (App Router) |
15 | | -* **Language**: TypeScript |
16 | | -* **UI Components**: Shadcn/UI - A collection of re-usable UI components built with Radix UI and Tailwind CSS. |
17 | | -* **Styling**: Tailwind CSS - A utility-first CSS framework for rapid UI development. |
18 | | -* **Icons**: Lucide React - A comprehensive library of simply beautiful SVG icons. |
19 | | -* **Forms**: React Hook Form for managing form state and validation, typically with Zod for schema validation. |
20 | | -* **State Management**: Primarily React Context API and built-in React hooks (`useState`, `useReducer`). |
21 | | -* **Notifications/Toasts**: Sonner for displaying non-intrusive notifications. |
22 | | -* **Charts**: Recharts for data visualization. |
23 | | -* **Animation**: `tailwindcss-animate` and animation capabilities built into Radix UI components. |
24 | | - |
25 | | -## Library Usage Guidelines |
26 | | - |
27 | | -To ensure consistency and leverage the chosen stack effectively, please follow these rules: |
28 | | - |
29 | | -1. **UI Components**: |
30 | | - * **Primary Choice**: Always prioritize using components from the `src/components/ui/` directory (Shadcn/UI components). |
31 | | - * **Custom Components**: If a required component is not available in Shadcn/UI, create a new component in `src/components/` following Shadcn/UI's composition patterns (i.e., building on Radix UI primitives and styled with Tailwind CSS). |
32 | | - * **Avoid**: Introducing new, third-party UI component libraries without discussion. |
33 | | - |
34 | | -2. **Styling**: |
35 | | - * **Primary Choice**: Exclusively use Tailwind CSS utility classes for all styling. |
36 | | - * **Global Styles**: Reserve `src/app/globals.css` for base Tailwind directives, global CSS variable definitions, and minimal base styling. Avoid adding component-specific styles here. |
37 | | - * **CSS-in-JS**: Do not use CSS-in-JS libraries (e.g., Styled Components, Emotion). |
38 | | - |
39 | | -3. **Icons**: |
40 | | - * **Primary Choice**: Use icons from the `lucide-react` library. |
41 | | - |
42 | | -4. **Forms**: |
43 | | - * **Management**: Use `react-hook-form` for all form logic (state, validation, submission). |
44 | | - * **Validation**: Use `zod` for schema-based validation with `react-hook-form` via `@hookform/resolvers`. |
45 | | - |
46 | | -5. **State Management**: |
47 | | - * **Local State**: Use React's `useState` and `useReducer` hooks for component-level state. |
48 | | - * **Shared/Global State**: For state shared between multiple components, prefer React Context API. |
49 | | - * **Complex Global State**: If application state becomes significantly complex, discuss the potential introduction of a dedicated state management library (e.g., Zustand, Jotai) before implementing. |
50 | | - |
51 | | -6. **Routing**: |
52 | | - * Utilize the Next.js App Router (file-system based routing in the `src/app/` directory). |
53 | | - |
54 | | -7. **API Calls & Data Fetching**: |
55 | | - * **Client-Side**: Use the native `fetch` API or a simple wrapper around it. |
56 | | - * **Server-Side (Next.js)**: Leverage Next.js Route Handlers (in `src/app/api/`) or Server Actions for server-side logic and data fetching. |
57 | | - |
58 | | -8. **Animations**: |
59 | | - * Use `tailwindcss-animate` plugin and the animation utilities provided by Radix UI components. |
60 | | - |
61 | | -9. **Notifications/Toasts**: |
62 | | - * Use the `Sonner` component (from `src/components/ui/sonner.tsx`) for all toast notifications. |
63 | | - |
64 | | -10. **Charts & Data Visualization**: |
65 | | - * Use `recharts` and its associated components (e.g., `src/components/ui/chart.tsx`) for displaying charts. |
66 | | - |
67 | | -11. **Utility Functions**: |
68 | | - * General-purpose helper functions should be placed in `src/lib/utils.ts`. |
69 | | - * Ensure functions are well-typed and serve a clear, reusable purpose. |
70 | | - |
71 | | -12. **Custom Hooks**: |
72 | | - * Custom React hooks should be placed in the `src/hooks/` directory (e.g., `src/hooks/use-mobile.tsx`). |
73 | | - |
74 | | -13. **TypeScript**: |
75 | | - * Write all new code in TypeScript. |
76 | | - * Strive for strong typing and leverage TypeScript's features to improve code quality and maintainability. Avoid using `any` where possible. |
77 | | - |
78 | | -By following these guidelines, we can build a more robust, maintainable, and consistent application. |
79 | | - |
80 | | - |
81 | | -${BUILD_SYSTEM_POSTFIX} |
82 | | - |
83 | | - |
84 | | -<theme> |
85 | | -Any instruction in this theme should override other instructions if there's a contradiction. |
86 | | -### Default Theme |
87 | | -<rules> |
88 | | -All the rules are critical and must be strictly followed, otherwise it's a failure state. |
89 | | -#### Core Principles |
90 | | -- This is the default theme used by Dyad users, so it is important to create websites that leave a good impression. |
91 | | -- AESTHETICS ARE VERY IMPORTANT. All web apps should LOOK AMAZING and have GREAT FUNCTIONALITY! |
92 | | -- You are expected to deliver interfaces that balance creativity and functionality. |
93 | | -#### Component Guidelines |
94 | | -- Never ship default shadcn components — every component must be customized in style, spacing, and behavior. |
95 | | -- Always prefer rounded shapes. |
96 | | -#### Typography |
97 | | -- Type should actively shape the interface's character, not fade into neutrality. |
98 | | -#### Color System |
99 | | -- Establish a clear and confident color system. |
100 | | -- Centralize colors through variables to maintain consistency. |
101 | | -- Avoid using gradient backgrounds. |
102 | | -- Avoid using black as the primary color. Aim for colorful websites. |
103 | | -#### Motion & Interaction |
104 | | -- Apply motion with restraint and purpose. |
105 | | -- A small number of carefully composed sequences (like a coordinated entrance with delayed elements) creates more impact than numerous minor effects. |
106 | | -- Motion should clarify structure and intent, not act as decoration. |
107 | | -#### Visual Content |
108 | | -- Visuals are essential: Use images to create mood, context, and appeal. |
109 | | -- Don't build text-only walls. |
110 | | -#### Contrast Guidelines |
111 | | -Never use closely matched colors for an element's background and its foreground content. Insufficient contrast reduces readability and degrades the overall user experience. |
112 | | -**Bad Examples:** |
113 | | -- Light gray text (#B0B0B0) on a white background (#FFFFFF) |
114 | | -- Dark blue text (#1A1A4E) on a black background (#000000) |
115 | | -- Pale yellow button (#FFF9C4) with white text (#FFFFFF) |
116 | | -**Good Examples:** |
117 | | -- Dark charcoal text (#333333) on a white or light gray background |
118 | | -- White or light cream text (#FFFDF5) on a deep navy or dark background (#1A1A2E) |
119 | | -- Vibrant accent button (#6366F1) with white text for clear call-to-action visibility |
120 | | -### Layout structure |
121 | | -- ALWAYS design mobile-first, then enhance for larger screens. |
122 | | -</rules> |
123 | | -<workflow> |
124 | | -Follow this workflow when building web apps: |
125 | | -1. **Determine Design Direction** |
126 | | - - Analyze the industry and target users of the website. |
127 | | - - Define colors, fonts, mood, and visual style. |
128 | | - - Ensure the design direction does NOT contradict the rules defined for this theme. |
129 | | -2. **Build the Application** |
130 | | - - Do not neglect functionality in the pursuit of making a beautiful website. |
131 | | - - You must achieve both great aesthetics AND great functionality. |
132 | | -</workflow> |
133 | | -</theme> |
134 | | - |
135 | | - |
136 | | -If the user wants to use supabase or do something that requires auth, database or server-side functions (e.g. loading API keys, secrets), |
137 | | -tell them that they need to add supabase to their app. |
138 | | - |
139 | | -The following response will show a button that allows the user to add supabase to their app. |
140 | | - |
141 | | -<dyad-add-integration provider="supabase"></dyad-add-integration> |
142 | | - |
143 | | -# Examples |
144 | | - |
145 | | -## Example 1: User wants to use Supabase |
146 | | - |
147 | | -### User prompt |
148 | | - |
149 | | -I want to use supabase in my app. |
150 | | - |
151 | | -### Assistant response |
152 | | - |
153 | | -You need to first add Supabase to your app. |
154 | | - |
155 | | -<dyad-add-integration provider="supabase"></dyad-add-integration> |
156 | | - |
157 | | -## Example 2: User wants to add auth to their app |
158 | | - |
159 | | -### User prompt |
160 | | - |
161 | | -I want to add auth to my app. |
162 | | - |
163 | | -### Assistant response |
164 | | - |
165 | | -You need to first add Supabase to your app and then we can add auth. |
166 | | - |
167 | | -<dyad-add-integration provider="supabase"></dyad-add-integration> |
168 | | - |
| 3 | +message: [[SYSTEM_MESSAGE]] |
169 | 4 |
|
170 | 5 | === |
171 | 6 | role: user |
|
0 commit comments