About .cursorrules prompt file
What you can build
Shopify Storefront Generator: A tool that allows users to easily generate a Shopify storefront using Polaris components and Tailwind CSS for a consistent and responsive design. It should integrate with the Shopify Admin GraphQL API for product management and ensure security best practices are adhered to.
Custom Shopify Dashboard: A web app that uses the Shopify Admin GraphQL API to create a personalized dashboard for Shopify store owners. This app would manage API queries and mutations through dedicated modules, incorporating Polaris for UI components and Tailwind CSS for design flexibility.
Prisma-Integrated E-commerce Platform: An e-commerce platform that utilizes Prisma for database operations and Shopify API for seamless product and order management. It would ensure database integrity using Prisma's relations and provide a user-friendly interface with Polaris and Tailwind CSS.
Shopify Theme Builder: An application that allows designers to create custom Shopify themes using Polaris components for consistent UI elements and Tailwind CSS for design prototyping. The tool would guide users through Shopify's security practices to ensure their stores are compliant.
Collaborative Code Review App: A service that facilitates code reviews for Shopify development projects, focusing on key areas such as clarity, performance, and security. It would provide feedback for evolving coding practices and support discussions on implementation choices.
Shopify API Query Editor: A developer tool for managing Shopify API queries and mutations, ensuring secure access and efficient data fetching using modern syntax. This tool should be integrated with ESLint and other linters to maintain code quality.
Schema Management for Shopify: A utility to define and manage database schemas using Prisma syntax specifically for Shopify-related projects. It would support relational integrity and provide clear documentation of conventions within the codebase.
Responsive Design Prototyper: An app that allows developers to prototype responsive designs quickly using Tailwind's utility-first classes integrated with Polaris components. This tool would enforce style separation to maintain clean codebases.
Shopify Convention Clarifier: An online resource or app designed to clarify and document project-specific conventions for Shopify development, encouraging collaborative development and continuous engagement in discussions about trade-offs and design choices.
Benefits
- Consistent API use with focus on adopting the Shopify Admin GraphQL API, managing operations via dedicated modules, and adhering to security practices.
- Integration of Polaris for UI components and Tailwind for utility-first styling, with directives to separate Tailwind from Polaris stylesheets.
- Emphasis on database schema management and operations using Prisma, highlighting relational integrity and schemas defined in schema.prisma.
Synopsis
Shopify app developers can use this prompt to build a robust, scalable e-commerce platform integrating Shopify API, Polaris, Tailwind CSS, and Prisma while adhering to best coding practices.
Overview of .cursorrules prompt
The .cursorrules file establishes coding guidelines and best practices for developers working on a project that utilizes Shopify, Polaris, Tailwind CSS, and Prisma. It includes rules for naming conventions, securing Shopify API access, and integrating Polaris with Tailwind CSS. It emphasizes the importance of adhering to specific project conventions, conducting regular code reviews, and maintaining high code quality. Additionally, it highlights the significance of collaborative development through continuous clarification of conventions and engaging in discussions. The file also configures linters for ESLint, Tailwind CSS, and Prisma to ensure code consistency. Developers are encouraged to use modern Node.js syntax, Tailwind CSS classes, Polaris components, and Prisma for database interactions. Communication should be brief and to the point.
