Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 2.4 KB

File metadata and controls

68 lines (51 loc) · 2.4 KB

Taubyte Development Guide

For AI Assistants

This guide is specifically designed for AI coding agents working on full stack Taubyte projects. It's decomposed into focused files for better comprehension.

Quick Start

  1. Read the index: 00-INDEX.md
  2. Critical rules: 01-CRITICAL-RULES.md
  3. Pick your topic: Use the index to find the right file

Guide Structure

  • 00-INDEX.md - Navigation and quick decision tree
  • 01-CRITICAL-RULES.md - MUST READ - Forbidden patterns and rules
  • 02-ARCHITECTURE.md - Taubyte platform overview
  • 03-IMPORTS.md - Required SDK packages
  • 04-FUNCTION-EXPORT.md - Function export patterns
  • 05-HTTP-HANDLING.md - HTTP request/response patterns
  • 06-REST-API.md - REST API templates
  • 07-ERROR-HANDLING.md - Error handling and CORS
  • 08-PUBSUB.md - Pub/Sub messaging
  • 09-RESOURCES.md - Official documentation links
  • 10-TAUBYTE-CONFIG.md - .taubyte folder configuration
  • 11-BINARY-DATA-PROCESSING.md - Binary data parsing for pub/sub events
  • database/ - Database operations guide
  • utilities/ - Utility functions guide
  • ai-help/ - AI troubleshooting guide

Getting Started

  • HOW-TO-START.md - Simple instructions for users
  • START-NEW-PROJECT.md - AI instructions for project creation
  • GENERIC-PROMPT.md - Generic prompt template for any project
  • EXAMPLE-CUSTOMIZED-PROMPT.md - Example of customized prompt

How to Use

"I need to create..."

  • HTTP endpoint → 05-HTTP-HANDLING.md + 06-REST-API.md
  • Database function → database/README.md
  • Real-time messaging → 08-PUBSUB.md
  • Utility functions → utilities/README.md
  • Project setup → 10-TAUBYTE-CONFIG.md
  • Binary data parsing → 11-BINARY-DATA-PROCESSING.md
  • AI troubleshooting → ai-help/README.md

"I want to create a new project..."

  • Just say "cursor start new project" → HOW-TO-START.md
  • AI instructions → START-NEW-PROJECT.md
  • Use the generic prompt → GENERIC-PROMPT.md
  • See an example → EXAMPLE-CUSTOMIZED-PROMPT.md

"I'm getting errors..."

  • Import errors → 03-IMPORTS.md
  • Export errors → 04-FUNCTION-EXPORT.md
  • HTTP errors → 07-ERROR-HANDLING.md

Official Resources