ReaDDy

https://github.com/whitedoveliu/readdy-help-docs
Admin
ReaDDy is a powerful, open-source framework for event-driven, particle-based reactive molecular...
Tokens:25,773
Snippets:202
Trust Score:3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Generate Based on Design Reference Prompt

Source: https://github.com/whitedoveliu/readdy-help-docs/blob/main/tricks/prompting-tips.mdx

This prompt guides the AI to use a provided image as a design reference, focusing on specific elements like the color palette for generation. It requires uploading an image to Readdy and referencing it in the prompt.

```text
Reference the color palette from this image to generate a...
```

--------------------------------

### Configure DNS for Custom Domain Publishing

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

This snippet provides DNS record configurations for directing a custom domain to Readdy's publishing service. It includes A and CNAME records for root and www subdomains, respectively, and example configurations for GoDaddy and Cloudflare.

```text
# For root domain (example.com):
Record Type: A
Name: @ (or leave blank)
Value: 52.37.165.222
TTL: Auto or 3600

# For www subdomain:
Record Type: CNAME
Name: www
Value: publish.readdy.site
TTL: Auto or 3600

# Example for GoDaddy:
1. Login to GoDaddy account
2. Go to Domain Portfolio > DNS
3. Add Record > Type: A
   - Name: @
   - Value: 52.37.165.222
   - TTL: 600 seconds
4. Add Record > Type: CNAME
   - Name: www
   - Value: publish.readdy.site
   - TTL: 1 Hour
5. Save all records

# Example for Cloudflare:
1. Login to Cloudflare dashboard
2. Select domain
3. Go to DNS > Records
4. Add record:
   - Type: A
   - Name: @
   - IPv4 address: 52.37.165.222
   - Proxy status: Proxied (orange cloud)
5. Add record:
   - Type: CNAME
   - Name: www
   - Target: publish.readdy.site
   - Proxy status: Proxied
```

--------------------------------

### Shopify Integration: Specific Collection Import

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

Example of importing products from a specific Shopify collection ('Summer Collection') and displaying them in a carousel format with quick view functionality. Features include collection filtering, product variant selection, quantity selection, cart management, and a checkout button linking to Shopify.

```javascript
// Generated features:
// - Collection filtering
// - Product variant selection (size, color)
// - Quantity selector
// - Cart management
// - Checkout button to Shopify
```

--------------------------------

### Implement Micro-interactions and Animations Prompt

Source: https://github.com/whitedoveliu/readdy-help-docs/blob/main/tricks/prompting-tips.mdx

This prompt instructs the AI to implement subtle animations and micro-interactions, aiming to enhance user engagement on landing pages. It leverages Readdy's conversational prompting for efficient animation implementation.

```text
Implement subtle animations and micro-interactions to enhance user engagement
```

--------------------------------

### Configure Readdy Agent Global Prompt

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

Sets the core instructions for the Readdy customer service assistant. This prompt defines its responsibilities, tone, and how to handle unknown queries, ensuring consistent and helpful customer interactions.

```text
You are a helpful customer service assistant for [Your Company Name].
Your responsibilities:
- Answer questions about our products and services
- Help schedule appointments
- Collect customer contact information
- Maintain a friendly and professional tone
- If you don't know an answer, offer to connect the customer with a human representative
```

--------------------------------

### Supabase Edge Function: Email Validation and Sending

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

An example of an Edge Function designed for validating email addresses and sending welcome emails using SendGrid. The generated function structure includes input validation, SendGrid API calls, response formatting, and CORS handling.

```typescript
// Generated function structure:
// - Input validation
// - SendGrid API call
// - Response formatting
// - CORS handling
```

--------------------------------

### Configure Readdy Agent FAQs

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

Adds frequently asked questions and their answers to the Readdy Agent. This allows the agent to quickly provide information on common queries, improving response times and customer satisfaction.

```text
FAQ 1:
Q: What are your business hours?
A: We're open Monday-Friday 9 AM - 5 PM EST

FAQ 2:
Q: What services do you offer?
A: We offer web design, SEO optimization, and digital marketing services.

FAQ 3:
Q: How much does a website cost?
A: Custom websites start at $2,500. We'll provide a detailed quote after understanding your requirements.
```

--------------------------------

### Supabase Edge Function: AI Chatbot with OpenAI

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

An example of an Edge Function for integrating an AI chatbot using OpenAI's GPT-4o API. This function handles streaming responses, context management, and error handling for chat interactions. It requires the OPENAI_API_KEY environment variable.

```typescript
// chat-completion.ts
// OpenAI API integration
// Streaming response handling
// Context management
// Error handling
```

--------------------------------

### Manual SEO Configuration for Homepage

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

Manually configures SEO settings for the homepage, including setting the website title, meta description, keywords, and specifying the favicon. This provides precise control over search engine appearance.

```text
# Manual SEO configuration
"Configure the SEO for homepage with these details:
1. Use the attached image as the website icon
2. Set the website title to: 'Acme Digital Solutions - Web Design & Development'
3. Set meta description to: 'Expert web design and development services for businesses. Custom websites, e-commerce solutions, and digital marketing. Get your free quote today.'
4. Keywords: web design, web development, digital marketing, e-commerce
5. Enable indexing for search engines"
```

--------------------------------

### Shopify Integration: Importing Products

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

Details on automatically fetching and importing product data from a Shopify store into a project. This includes product details like title, price, images, and variants, and automatically generates a product grid layout with 'Add to Cart' functionality and redirects to Shopify checkout.

```javascript
// This automatically:
// - Fetches all products from Shopify
// - Imports product data (title, price, images, variants)
// - Creates product grid layout
// - Adds "Add to Cart" functionality
// - Implements Shopify checkout redirect
```

--------------------------------

### Next.js Multi-Page Structure and Generation

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

This snippet illustrates the file structure for a multi-page Next.js application and demonstrates how new pages, including dynamic routes, can be generated through conversational prompts. It highlights the use of `page.tsx` for page content and `layout.tsx` for shared UI.

```text
# Step 1: Initialize multi-page project
"Create a business website with navigation for: Home, Services, About, Contact"

# Generated structure:
# /src/app/
#   page.tsx (Home)
#   services/page.tsx
#   about/page.tsx
#   contact/page.tsx
#   layout.tsx (shared layout with navigation)
#   not-found.tsx (custom 404 page)

# Step 2: Add new pages through conversation
"Please add a blog page with article listings and individual article pages with dynamic routing."

# Generated pages:
# /src/app/blog/
#   page.tsx (blog listing)
```

--------------------------------

### Per-Page SEO Configuration JSON

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

Defines SEO parameters for individual pages using JSON format. This includes title, description, keywords, indexability, and favicon settings, allowing for granular control over each page's search engine optimization.

```json
# Per-page SEO configuration:
# Homepage (index):
{
  "title": "Acme Digital Solutions - Web Design & Development",
  "description": "Expert web design and development services...",
  "keywords": "web design, web development, digital marketing",
  "indexable": true,
  "favicon": "favicon.ico"
}

# About page:
{
  "title": "About Us - Acme Digital Solutions",
  "description": "Learn about our team and mission...",
  "keywords": "about us, web design team, company history",
  "indexable": true
```

--------------------------------

### Shopify Product Data Structure

Source: https://context7.com/whitedoveliu/readdy-help-docs/llms.txt

The expected data structure for products imported from Shopify. This includes the product ID, title, price, a list of image URLs, and an array of product variants, each with its own ID, title, price, and availability status.

```json
{
  "id": "gid://shopify/Product/123",
  "title": "Product Name",
  "price": "$29.99",
  "images": ["url1", "url2"],
  "variants": [{"id", "title", "price", "available"}]
}
```
Tokens:
Raw