NEW

Next.js Expo Tailwind CSS .cursorrules prompt file

Dishify Project Guidelines

Project Overview

Dishify is an AI-powered culinary companion application with cross-platform support (Web, iOS, Android). It provides instant recipe generation, ingredient lists, and smart shopping features.

Tech Stack

Next.js (14.2.7) for web application
Expo (SDK 51.0.31) for mobile applications
React Native (0.74.2) for cross-platform development
Tailwind CSS (3.4.4) for styling
tRPC (11.0.0) for type-safe API communication
Cloudflare Workers (3.73.0) for serverless backend with Hono
Cloudflare D1 for database
Supabase for authentication
TypeScript (5.5.4) as the primary language

Project Structure

apps/
expo/: Expo mobile app
next/: Next.js web app
packages/
api/: Backend API and database schema
app/: Shared application logic
ui/: Shared UI components
data_utils/: Utility scripts for preparing recipe data for the database

Code Style and Conventions

TypeScript is used for type safety across the project.
A functional programming approach is followed where possible.
Arrow functions are used for component definitions and callbacks.
const is used for variable declarations unless reassignment is necessary.
async/await is used for asynchronous operations.
ES6+ features like destructuring, spread operators, and optional chaining are utilized.

File Naming Conventions

kebab-case is used for file names (e.g., global-error.tsx).
PascalCase is used for component names (e.g., HomeScreen.tsx).
.tsx extension is used for React components and .ts for plain TypeScript files.
index.tsx is used for main component files in a directory.

Styling

Tailwind CSS is used for styling components.
Custom theme is defined in @dishify/ui/src/theme.js.
nativewind is used for React Native styling.

State Management

React Query is used for server state management.
Jotai is used for client-side state management.

API and Data Fetching

tRPC is used for type-safe API communication.
API routes are defined in packages/api/src/routes/.
React Query hooks are used for data fetching and caching.

Error Handling and Logging

Error boundaries are implemented for graceful error handling.
React <Suspense> boundaries are used for handling loading states.
Best practices include:

Catching and handling errors at appropriate levels
Providing user-friendly error messages
Logging errors for debugging purposes

Testing

Unit tests are implemented for critical functions and components.
Jest is used as the testing framework.

Build and Deployment

GitHub Actions are used for CI/CD pipelines.
EAS (Expo Application Services) is used for mobile app builds and submissions.
The web app is deployed to Cloudflare Pages.
The backend is deployed to Cloudflare Workers.

Environment Variables

.env.local is used for local development.
Appropriate prefixes are used for different platforms (e.g., NEXT_PUBLIC_ for Next.js, EXPO_PUBLIC_ for Expo).

Code Quality Tools

Biome is used for linting and formatting.
Biome rules are configured in biome.json.
The linting style enforces consistent code formatting, proper naming conventions, and best practices for React and TypeScript development.

Performance Optimization

React.memo is used for component memoization when necessary.
useCallback() is utilized for optimizing callback functions.
Code splitting and lazy loading are implemented for better performance.

Commenting Style

JSDoc-style comments are used for functions, classes, and interfaces in TypeScript files.
Single-line comments (//) are used for brief explanations or TODO notes.
Multi-line comments (/_ _/) are used for longer explanations or temporary code disabling.
React components are documented with a brief description above the component definition.
Complex logic or algorithms are explained with inline comments.
Comments are kept concise and focus on explaining "why" rather than "what" when the code is not self-explanatory.
For API routes, each endpoint is documented with its purpose, parameters, and return type.

When providing code snippets or recommendations, always include appropriate comments following these guidelines to maintain consistency with the existing codebase.

Accessibility

Proper accessibility attributes are used in components.
The application is tested with screen readers and keyboard navigation.

When providing recommendations or discussing code implementation, please adhere to these guidelines to maintain consistency across the project.

stack:

Next.js Expo Tailwind CSS .cursorrules prompt file

Kevin Kidd

NEW

Tailwind CSS Next.js Guide .cursorrules prompt file

Prompt Generation Rules:
- Analyze the component requirements thoroughly
- Include specific DaisyUI component suggestions
- Specify desired Tailwind CSS classes for styling
- Mention any required TypeScript types or interfaces
- Include instructions for responsive design
- Suggest appropriate Next.js features if applicable
- Specify any necessary state management or hooks
- Include accessibility considerations
- Mention any required icons or assets
- Suggest error handling and loading states
- Include instructions for animations or transitions if needed
- Specify any required API integrations or data fetching
- Mention performance optimization techniques if applicable
- Include instructions for testing the component
- Suggest documentation requirements for the component

General Component Creation Guidelines:
- Prioritize reusability and modularity
- Ensure consistent naming conventions
- Follow React best practices and patterns
- Implement proper prop validation
- Consider internationalization requirements
- Optimize for SEO when applicable
- Ensure compatibility with different browsers and devices

General Rules:
- Enable strict TypeScript (strict: true in tsconfig.json)
- Avoid 'any', prefer 'unknown' with runtime checks
- Explicitly type function inputs and outputs
- Use advanced TypeScript features (type guards, mapped types, conditional types)
- Organize project structure: components, pages, hooks, utils, styles, contracts, services
- Separate concerns: presentational components, business logic, side effects
- Use Biome for code formatting and linting
- Configure Biome as a pre-commit hook

Next.js Rules:
- Use dynamic routes with bracket notation ([id].tsx)
- Validate and sanitize route parameters
- Prefer flat, descriptive routes
- Use getServerSideProps for dynamic data, getStaticProps/getStaticPaths for static
- Implement Incremental Static Regeneration (ISR) where appropriate
- Use next/image for optimized images
- Configure image layout, priority, sizes, and srcSet attributes

TypeScript Rules:
- Enable all strict mode options in tsconfig.json
- Explicitly type all variables, parameters, and return values
- Use utility types, mapped types, and conditional types
- Prefer 'interface' for extendable object shapes
- Use 'type' for unions, intersections, and primitive compositions
- Document complex types with JSDoc
- Avoid ambiguous union types, use discriminated unions when necessary

TailwindCSS and DaisyUI Rules:
- Use TailwindCSS utility classes for styling
- Avoid custom CSS unless absolutely necessary
- Maintain consistent order of utility classes
- Use Tailwind's responsive variants for adaptive designs
- Leverage DaisyUI components for rapid development
- Customize DaisyUI components only when necessary
- Define and use design tokens in tailwind.config.js

Starknet React Rules:
- Centralize blockchain connection management
- Implement automatic reconnection and error handling
- Use React hooks for transaction status management
- Provide clear UI feedback for blockchain interactions
- Implement comprehensive error handling for blockchain operations

Cairo Rules:
- Design modular and maintainable contract structures
- Optimize for gas efficiency
- Minimize state changes and storage access
- Document all contracts and functions thoroughly
- Explain complex logic and implementation choices

Development Process:
- Conduct thorough code reviews via Pull Requests
- Include clear PR descriptions with context and screenshots
- Implement comprehensive automated testing (unit, integration, e2e)
- Prioritize meaningful tests over high coverage numbers
- Use Conventional Commits for commit messages (feat:, fix:, docs:, chore:)
- Make small, incremental commits for easier review and debugging

Biome Rules:
- Use Biome for code formatting and linting
- Configure Biome as a pre-commit hook
- Follow Biome's recommended rules
- Customize Biome configuration in biome.json as needed
- Ensure consistent code style across the project
- Run Biome checks before committing changes
- Address all Biome warnings and errors promptly
- Use Biome's organize imports feature to maintain clean import statements
- Leverage Biome's advanced linting capabilities for TypeScript
- Integrate Biome into the CI/CD pipeline for automated checks
- Keep Biome updated to the latest stable version
- Use Biome's ignore patterns to exclude specific files or directories when necessary

stack: