About .cursorrules prompt file
What you can build
WhatsApp Chatbot Creator: A web app that allows users to create custom chatbots without coding. Users can leverage the WhatsApp Cloud API Ruby SDK to handle messages, templates, and media, generating Ruby scripts tailored to their specific business needs.
WhatsApp Analytics Dashboard: A platform that provides businesses with analytics based on message interactions and delivery reports using the WhatsApp Cloud API. It can help businesses optimize their communication strategies in real-time using the Ruby SDK for data processing and visualization.
Ruby SDK Documentation Generator: A service that automatically generates comprehensive documentation for WhatsApp Cloud API integrations using Ruby. It assists developers by providing in-depth examples and easy-to-understand guides based on YARD and Ruby conventions.
E-commerce Integration Tool: A software tool designed to integrate e-commerce platforms with WhatsApp for enhanced customer communication. Utilizing Ruby, this tool can push order confirmations, delivery updates, and promotions directly to customers via WhatsApp.
WhatsApp Bulk Messaging Service: A cloud-based solution that enables businesses to send bulk messages to customers over WhatsApp, powered by the WhatsApp Cloud API Ruby SDK. It can help manage media, templates, and error handling effectively.
Customer Support Automation Platform: A platform that automates customer support responses through WhatsApp's messaging service using Ruby. It utilizes the SDK's classes to manage messages and use templates for quick responses, improving customer satisfaction.
Business Profile Manager: A desktop application built with Ruby that allows businesses to manage their WhatsApp profiles, update business information, and handle phone numbers efficiently using the WhatsApp Cloud API.
WhatsApp Media Management App: An app for managing media files such as images, videos, and documents sent via WhatsApp. The Ruby SDK can be used to upload, download, and organize media efficiently, ensuring a seamless process for users.
WhatsApp Notifications Plugin for Ruby Apps: A plugin for Ruby on Rails applications to enable real-time notifications directly to users’ WhatsApp accounts. It uses the Ruby SDK for integration and communication management.
Event Registration and Notification System: An event management system that utilizes WhatsApp notifications for registrations, reminders, and updates. It leverages the Ruby SDK to manage communication templates and distributes messages effectively.
Benefits
- Clear instructions for comprehensive test coverage using minitest, robust error handling, and maintaining backward compatibility.
- Emphasizes modular and extensible SDK design for accommodating future updates to the WhatsApp Cloud API.
- Consistent code style and structure requirements, adhering to Ruby best practices and conventions with a focus on readability and maintainability.
Synopsis
Ruby developers building a WhatsApp Cloud API SDK can use this prompt to ensure structured, maintainable, and well-documented code aligned with best practices.
Overview of .cursorrules prompt
The .cursorrules file provides guidelines for developing a Ruby SDK for the WhatsApp Cloud API. It specifies the programming language, testing framework, linter, and appropriate file structure for source, test, and example files. It outlines dependencies and necessary documentation files. The file identifies key API classes and emphasizes writing idiomatic Ruby code, following Ruby conventions, and adhering to the Ruby Style Guide. It recommends comprehensive test coverage, documentation using YARD, modularity for future updates, robust error handling, and maintaining backwards compatibility.
