About .cursorrules prompt file
What you can build
Umo Document Collaboration Platform: Create a collaborative document editing platform using Umo Editor as the core editor, allowing multiple users to edit a document in real-time with Vue.js and WebSocket integrations for real-time updates.
Umo Editor Plugin Marketplace: Develop a marketplace for plugins and extensions for Umo Editor, enabling users to enhance their editor's functionality with third-party tools and features, similar to VSCode's extension marketplace.
Umo Editor Blogging Platform: Build a blogging platform with Umo Editor as the primary tool for creating blog posts, integrating SEO tools and social media sharing functionalities for a seamless blogging experience.
Educational Content Creation Tool: Create a platform for educators to design interactive and rich-text educational content using Umo Editor, providing templates and modules for assessments, lessons, and multimedia integration.
Technical Documentation Generator: Develop a service that utilizes Umo Editor for generating and maintaining technical documentation, with features like version control, team collaboration, and JSON/YAML export options.
Umo Editor Personal Notebook App: Design a personal notebook application leveraging Umo Editor, featuring tagging, search functionality, and cloud sync to allow users to take notes and manage information efficiently.
Umo Editor-Powered CMS (Content Management System): Build a CMS that uses Umo Editor for content creation, integrated with headless CMS APIs for managing and delivering content to websites and apps.
Umo Editor-based Slide Presentation Tool: Create a slide presentation tool utilizing Umo Editor for creating visually appealing and interactive slides, with options for exporting slideshows in PDF and HTML formats.
Legal Document Automation Tool: Develop a system for automating the creation of legal documents using Umo Editor, with pre-loaded templates and collaboration features for legal teams.
Umo Writing Competition Platform: Establish an online writing competition platform where participants can submit entries using Umo Editor, and judges can review and provide feedback within the editor itself.
Benefits
- Integrated testing with
vitest, using@testing-library/vueand@faker-js/fakerfor robust, mock data-based test outcomes. - Strict adherence to
Prettierrules with TypeScript path aliases for maintained code structure and clarity. - Seamless typing and type checking with
@tool-belt/type-predicatesand advanced Vue.js support viaVueMacroesand reactivity transform configurations.
Synopsis
Developers building rich-text editors with Vue.js and Tiptap will benefit from this prompt by leveraging guidelines for efficient code structure, stylistic consistency, and robust testing practices.
Overview of .cursorrules prompt
The .cursorrules file outlines the configuration and coding practices for developing with the Umo Editor, a rich-text document editor built using Vue.js 3, Tiptap, TypeScript, and Vite. It emphasizes best practices for using functional programming, strong typing, and importing utilities from the `@tool-belt/type-predicates` library. Developers should adhere to formatting rules specified by Prettier, and leverage TypeScript path aliases. The file also provides guidelines for testing using `vitest`, instructing the use of BDD practices, mock data with `@faker-js/faker`, and the organization of test files.
