Skip to content

SCHEMA_README.md

Latest commit

 

History

History
428 lines (332 loc) · 10.3 KB

SCHEMA_README.md

File metadata and controls

428 lines (332 loc) · 10.3 KB
Raw

🚀 Tenchat Database Schema - Quick Start

What Just Happened?

You now have a production-ready, scalable database schema for Tenchat that includes:

✅ 30 Collections across 5 specialized databases ✅ 12 Storage Buckets for all media types
✅ Full Web3 Integration (multi-chain wallets, NFTs, crypto gifting) ✅ Social Features (stories, posts, comments, follows) ✅ Gamification (XP, levels, badges, streaks) ✅ Real-time Messaging with E2E encryption support ✅ AR Filters & Rich Media ✅ Smart Contract Hooks for future decentralization

📚 Documentation

Document Description
DATABASE_SCHEMA.md Complete technical documentation of all collections, relationships, and design decisions
DEPLOYMENT_GUIDE.md Step-by-step guide to deploy the schema to Appwrite
FEATURE_COMPARISON.md How Tenchat compares to WhatsApp, Telegram, Discord

⚡ Quick Deploy

# 1. Generate the latest schema
node generate-schema.cjs

# 2. Deploy to Appwrite
appwrite deploy

# That's it! 🎉

🗂️ Database Structure

5 Specialized Databases

📦 MainDatabase (mainDB)
├── profiles          # User profiles & identity
├── conversations     # All chat rooms (DM, group, channel)
├── messages          # All messages with E2E encryption
├── messageQueue      # Reliable message delivery
├── contacts          # User connections
├── typingIndicators  # Real-time typing status
└── presence          # Online/offline tracking

📦 SocialDatabase (socialDB)
├── stories           # 24-hour ephemeral content
├── storyViews        # Story engagement tracking
├── posts             # Permanent social posts
├── postReactions     # Likes, emoji reactions
├── comments          # Post comments & replies
└── follows           # Social connections

📦 Web3Database (web3DB)
├── wallets           # Multi-chain wallet connections
├── nfts              # User's NFT collection
├── cryptoTransactions # On-chain tx tracking
├── tokenGifts        # Crypto gifting feature
├── contractHooks     # Smart contract integration
└── tokenHoldings     # Token balance tracking

📦 ContentDatabase (contentDB)
├── stickers          # Platform & custom stickers
├── stickerPacks      # Sticker collections
├── userStickers      # User's sticker library
├── gifs              # Integrated GIF library
├── polls             # Interactive polls
├── arFilters         # AR filters for stories
└── mediaLibrary      # User's uploaded media

📦 AnalyticsDatabase (analyticsDB)
├── userActivity      # Engagement tracking
├── notifications     # Push notifications
├── appAnalytics      # System-wide metrics
└── errorLogs         # Error tracking

🎯 Key Features

💬 Messaging (Telegram-Level Scale)

  • Group sizes: Up to 200,000 members
  • E2E encryption: Built-in support
  • Message types: 16+ types (text, image, video, crypto, NFT, etc.)
  • Real-time: Typing indicators, read receipts, online presence
  • Reliable delivery: Message queue system

📸 Social Features (Instagram-Style)

  • Stories: 24h ephemeral content with AR filters
  • Posts: Permanent content with comments & reactions
  • Hashtags: Discover trending content
  • Follows: Social graph for virality
  • Engagement: Unlimited emoji reactions

💎 Web3 Integration (First-Class)

  • Multi-chain: Ethereum, Polygon, Solana, BSC, Avalanche, Arbitrum, Optimism, Base
  • NFT display: Show off your collection
  • Crypto gifting: Send tokens/NFTs with animations
  • Smart contracts: Hooks for future decentralization
  • Wallet management: Multiple wallets per user

🎮 Gamification

  • XP & Levels: Earn experience, level up
  • Badges: Achievement system
  • Streaks: Daily activity rewards
  • Reputation: Community-driven scores
  • Leaderboards: Compete with friends

🎨 Content Creation

  • AR Filters: Face, world, hand, body effects
  • Custom Stickers: Create & sell sticker packs
  • GIFs: Integrated library
  • Polls: Interactive voting
  • Rich Media: Full support for images, videos, audio

📊 Scale & Performance

Built for Billions

Metric Capacity Notes
Group Size 200,000 Telegram-level
Storage Unlimited Per-file limits apply
Messages Unlimited Properly indexed
Real-time High throughput Optimized queries
Databases 5 Independent scaling
Collections 30 Specialized & efficient

Performance Optimizations

✅ Composite indexes on frequently queried fields
✅ Denormalized data for fast reads
✅ Array fields for scalable relationships
✅ Message queue for reliability
✅ Presence system with auto-expiry
✅ Sharding-ready architecture

🔐 Security & Privacy

Authentication

  • Multi-method (email, phone, Web3 wallet, social)
  • JWT tokens (1-year duration)
  • Up to 10 concurrent sessions
  • Anonymous guest support

Data Protection

  • E2E encryption for messages
  • Encrypted storage for sensitive data
  • Document-level security
  • IP tracking in audit logs

Privacy Controls

  • Granular per-user settings
  • Read receipt control
  • Online status hiding
  • Blocked user management

🚀 Getting Started

1. Review the Schema

# Read the full documentation
cat DATABASE_SCHEMA.md

# Or open in your editor
code DATABASE_SCHEMA.md

2. Customize (Optional)

Edit generate-schema.cjs to:

  • Add custom collections
  • Modify attributes
  • Change relationships
  • Adjust indexes

Then regenerate:

node generate-schema.cjs

3. Deploy

# Install Appwrite CLI
npm install -g appwrite-cli

# Login
appwrite login

# Deploy everything
appwrite deploy

4. Integrate with Your App

// src/lib/appwrite-config.ts
export const DATABASE_IDS = {
  MAIN: 'mainDB',
  SOCIAL: 'socialDB',
  WEB3: 'web3DB',
  CONTENT: 'contentDB',
  ANALYTICS: 'analyticsDB',
};

export const COLLECTION_IDS = {
  PROFILES: 'profiles',
  CONVERSATIONS: 'conversations',
  MESSAGES: 'messages',
  STORIES: 'stories',
  WALLETS: 'wallets',
  NFTS: 'nfts',
  // ... etc
};

export const BUCKET_IDS = {
  AVATARS: 'avatars',
  MESSAGES: 'messages',
  STORIES: 'stories',
  // ... etc
};

🔄 Making Changes

Workflow

# 1. Edit schema generator
vim generate-schema.cjs

# 2. Regenerate
node generate-schema.cjs

# 3. Review changes
git diff appwrite.config.json

# 4. Test locally (if possible)
# Deploy to dev/staging environment first

# 5. Deploy to production
appwrite deploy

Safe Updates

  • Always test in staging first
  • Use --force flag carefully
  • Backup data before major changes
  • Deploy collections one at a time if unsure

📖 Example Queries

Get User Profile

const profile = await databases.getDocument(
  'mainDB',
  'profiles',
  userId
);

Send Message

const message = await databases.createDocument(
  'mainDB',
  'messages',
  ID.unique(),
  {
    conversationId: chatId,
    senderId: userId,
    content: encryptedContent,
    contentType: 'text',
    createdAt: new Date().toISOString(),
  }
);

Post Story

const story = await databases.createDocument(
  'socialDB',
  'stories',
  ID.unique(),
  {
    userId: userId,
    contentType: 'image',
    mediaFileId: uploadedFileId,
    expiresAt: new Date(Date.now() + 24*60*60*1000).toISOString(),
    createdAt: new Date().toISOString(),
  }
);

Send Crypto Gift

const gift = await databases.createDocument(
  'web3DB',
  'tokenGifts',
  ID.unique(),
  {
    senderId: userId,
    recipientId: friendId,
    giftType: 'token',
    chain: 'ethereum',
    tokenAmount: '10000000000000000', // 0.01 ETH
    animation: 'confetti',
    status: 'pending',
    createdAt: new Date().toISOString(),
  }
);

🎯 Next Steps

Phase 1: Backend Integration

  • Update service classes to use new schema
  • Implement messaging service
  • Add story functionality
  • Integrate wallet connection
  • Add crypto gift handling

Phase 2: Frontend Updates

  • Update UI components
  • Add stories page
  • Build AR filter interface
  • Create NFT gallery
  • Add gamification UI

Phase 3: Real-time Features

  • Set up real-time subscriptions
  • Implement typing indicators
  • Add online presence
  • Create push notifications
  • Build message queue worker

Phase 4: Web3 Integration

  • Connect to blockchain RPCs
  • Implement wallet signatures
  • Add NFT metadata fetching
  • Build token balance tracking
  • Create smart contract hooks

❓ FAQ

Q: Do I need to deploy all databases?
A: Yes, for full functionality. But you can start with MainDB for MVP.

Q: Can I modify the schema later?
A: Yes! Edit generate-schema.cjs and redeploy.

Q: What's the cost on Appwrite Cloud?
A: Free tier: 75K reads, 37.5K writes/day. Pro tier: $15/month base.

Q: Can I self-host?
A: Yes! Appwrite is open-source. Deploy on your own infrastructure.

Q: How do I add a new collection?
A: Edit generate-schema.cjs, add your collection, run node generate-schema.cjs, then appwrite deploy.

Q: Is this production-ready?
A: Yes! The schema is designed for scale and follows best practices.

🤝 Contributing

Want to improve the schema?

  1. Fork the repo
  2. Edit generate-schema.cjs
  3. Test thoroughly
  4. Submit a PR with documentation

📞 Support

  • 📖 Documentation: See DATABASE_SCHEMA.md
  • 🚀 Deployment: See DEPLOYMENT_GUIDE.md
  • 💡 Features: See FEATURE_COMPARISON.md
  • 🐛 Issues: Create an issue on GitHub
  • 💬 Discord: Join the community

🎉 What You've Built

You now have:

✨ A world-class database schema
🚀 Ready to scale to millions of users
💎 Web3-native architecture
🎨 Gen Z-focused features
🔐 Privacy-first design
📈 Production-ready infrastructure

This is the foundation for the next big social app. 🌟

Now go build something amazing! 🚀💪