WeWrite

A social wiki where every page you write is a fundraiser.

WeWrite transforms knowledge sharing into a collaborative economy where writers earn direct USD payments from their contributions and readers support creators with transparent monthly funding.

🌐 Connect With Us

• 🔗 Bento - All our links in one place
• 📸 Instagram - Behind the scenes and updates
• 🎥 YouTube - Tutorials and feature demos
• 🐦 Twitter - Real-time updates and community
• 💬 Discord - Join our community discussions

✨ What Makes WeWrite Special

• 📝 Collaborative Writing - Create and edit pages together
• 💰 Direct USD Payments - Support creators with transparent monthly funding
• 🔗 Smart Linking - Connect ideas across the platform
• 🌙 Beautiful Interface - Clean, modern design with dark mode
• 🔒 Secure & Private - Your data is protected and encrypted

🚀 Quick Start

WeWrite is built with Next.js and uses modern web technologies for optimal performance.

Prerequisites

• Node.js 18+
• pnpm (preferred package manager)

Installation

# Install pnpm if you don't have it
npm install -g pnpm

# Clone the repository
git clone https://github.com/WeWriteApp/WeWrite.git
cd WeWrite

# Install dependencies
pnpm install

# Set up environment variables
cp .env.example .env.local
# Edit .env.local with your configuration

# Run the development server
pnpm dev

Open http://localhost:3000 to see WeWrite in action! 🎉

📚 Documentation

📋 COMPLETE DOCUMENTATION INDEX - 🗂️ NAVIGATION HUB: Complete guide to all WeWrite documentation

🆕 Recent Changes (Start Here for 2025 Updates)

• SAVE_SYSTEM_RELIABILITY_ARCHITECTURE - 🆕 2025: Critical save system fixes, caching overhaul, and PWA update system
• RECENT_CHANGES_SUMMARY - 🆕 2025: Quick overview of major changes and what patterns to avoid
• EMERGENCY_COST_OPTIMIZATION_SUMMARY - 🚨 CRITICAL: Firebase cost optimization and real-time listener cleanup

🔒 Security & Core Systems (Essential Reading)

• USERNAME_SECURITY_GUIDELINES - 🔒 CRITICAL: Prevent email exposure vulnerabilities
• VERSION_SYSTEM - ESSENTIAL: Unified version system for page edit tracking
• AUTHENTICATION_ARCHITECTURE - Environment-specific authentication rules
• USER_DATA_FETCHING_PATTERNS - Standardized patterns for secure user data handling

💰 Storage Balance Payout System

WeWrite uses Stripe's Storage Balance system combined with the innovative "Use It or Lose It" model for perfect fund separation and enhanced auditability.

How It Works:

• Payments Balance = Platform Revenue (yours to keep)
• Storage Balance = Creator Obligations (escrowed by Stripe)
• "Use It or Lose It" = Unallocated funds become platform revenue

Key Benefits:

• ✅ Perfect Fund Separation in Stripe dashboard
• ✅ Stripe-Managed Auditability for regulatory compliance
• ✅ Enhanced Creator Trust through visible escrow
• ✅ Automated Monthly Payouts from Storage Balance
• ✅ Maintained Innovation with "use it or lose it" engagement

Documentation:

• STORAGE_BALANCE_GUIDE - 🆕 CURRENT: Complete Storage Balance system guide
• STRIPE_DASHBOARD_QUICK_REFERENCE - 🆕 CURRENT: Quick reference for Stripe dashboard
• PAYOUT_SYSTEM_DOCUMENTATION - Complete payout system documentation
• USD_MIGRATION_GUIDE - USD migration guide and architecture
• SUBSCRIPTION_SYSTEM - Complete subscription architecture and implementation
• PAYMENT_FLOW_TESTING_GUIDE - Comprehensive payment testing procedures
• ENHANCED_PAYMENT_ERROR_MESSAGING - User-friendly payment error handling
• PAYMENT_FAILURE_TRACKING - Payment failure audit and tracking system
• SUBSCRIPTION_TROUBLESHOOTING - Common payment issues and solutions
• PLATFORM_FEE_MANAGEMENT_SYSTEM - Platform fee configuration and management
• EMBEDDED_BANK_ACCOUNT_MANAGEMENT - Bank account setup and management
• PAYOUT_TROUBLESHOOTING_GUIDE - Payout system troubleshooting
• WEBHOOK_SETUP_GUIDE - Stripe webhook configuration

🏗️ Architecture & Environment

• CONTENT_DISPLAY_ARCHITECTURE - 🆕 2025: Unified content display system architecture
• CONTENT_DISPLAY_MIGRATION_GUIDE - 🆕 2025: Migration guide for content display refactoring
• CONTENT_DISPLAY_REFACTORING_SUMMARY - 🆕 2025: Complete refactoring summary and benefits
• ENVIRONMENT_ARCHITECTURE - Multi-environment setup and configuration
• ENVIRONMENT_QUICK_REFERENCE - Quick environment configuration reference
• FIREBASE_MIGRATION_ARCHITECTURE - Firebase project migration architecture
• SIMPLIFIED_ACTIVITY_SYSTEM - Activity tracking using recent pages
• SESSION_MANAGEMENT_ARCHITECTURE - Session management and authentication
• DEPENDENCY_MANAGEMENT_STANDARDS - Package management standards
• ARCHITECTURE_SIMPLIFICATION - System architecture improvements

🎨 User Interface & Experience

• SETTINGS_NAVIGATION_SYSTEM - User settings navigation and organization
• SETTINGS_PAYMENT_REORGANIZATION - Payment settings UI improvements
• BORDER_STYLING_GUIDELINES - UI border styling standards
• DOM_ELEMENT_IDENTIFIERS - Standardized DOM element identification
• LINE_BASED_EDITOR - Rich text editor implementation
• LINK_CURSOR_BEHAVIOR - Link interaction and cursor behavior
• SEARCH_SYSTEM - Search functionality and implementation

⚡ Performance & Optimization

• EMERGENCY_COST_OPTIMIZATION_SUMMARY - 🚨 CRITICAL: Firebase cost optimization and real-time listener cleanup
• PERFORMANCE_OPTIMIZATION_SUMMARY - System performance improvements
• DATABASE_SCHEMA_OPTIMIZATION_GUIDE - Database optimization strategies
• FIREBASE_INDEX_OPTIMIZATION - Firestore index optimization

🛠️ Development & Maintenance

• LEGACY_CODE_CLEANUP_GUIDE - ESSENTIAL: Identifying and removing deprecated patterns
• DEPRECATED_UI_PATTERNS - 🆕 2025: UI patterns that must be removed during cleanup
• AUTH_CLEANUP_GUIDE - Authentication system cleanup procedures
• DEVELOPMENT_AUTH_GUIDE - Development authentication setup
• PRODUCTION_DEPLOYMENT_GUIDE - Production deployment procedures
• AUTOMATED_ROUTE_TESTING - Automated testing procedures
• ADMIN_ACCOUNT_SETUP - Admin account configuration
• SUBSCRIPTION_QUICK_REFERENCE - Quick reference for subscription system

🛠️ Technology Stack

Core Technologies

• ⚛️ Next.js 14 - React framework with App Router
• 🔥 Firebase - Backend-as-a-Service platform
• 🎨 Tailwind CSS - Utility-first CSS framework
• 📝 Slate.js - Customizable rich text editor framework
• 💳 Stripe - Payment processing and subscriptions

Firebase Services

• 🗄️ Firestore - NoSQL document database for pages, users, and versions
• 🔐 Authentication - Email/password authentication with session management
• ☁️ Functions - Serverless functions for webhooks and background processing
• 📁 Storage - File storage for images and attachments

Development & Deployment

• 📦 pnpm - Fast, disk space efficient package manager
• 🚀 Vercel - Deployment platform with automatic CI/CD
• 📊 LogRocket - Session replay and error tracking
• 🔍 TypeScript - Type-safe JavaScript development

Key Features

• 🌙 Dark Mode - System-aware theme switching
• 📱 Responsive Design - Mobile-first responsive interface
• 🔗 Smart Linking - Automatic page linking and backlinks
• 💰 USD Creator Support - Direct USD payments to creators with transparent monthly funding
• 🔒 Security - Comprehensive security measures and data protection

📁 Project Structure

WeWrite/
├── app/                    # Next.js App Router
│   ├── api/               # API routes and endpoints
│   ├── auth/              # Authentication pages
│   ├── components/        # Reusable UI components
│   ├── contexts/          # React contexts for global state
│   ├── hooks/             # Custom React hooks
│   ├── lib/               # Utility libraries and helpers
│   ├── providers/         # Context providers
│   ├── settings/          # User settings pages
│   └── utils/             # Utility functions
├── docs/                  # Technical documentation
├── public/                # Static assets
└── functions/             # Firebase Cloud Functions

Key Directories

• app/ - Next.js 14 App Router with file-based routing
• app/components/ - Reusable UI components organized by feature
• app/api/ - API routes for backend functionality
• docs/ - Comprehensive technical documentation
• functions/ - Firebase Cloud Functions for webhooks and background tasks

🚀 Deployment

Automatic Deployment

WeWrite uses Vercel for automatic deployment:

• Production: Deploys from main branch to wewrite.app
• Preview: Deploys from dev branch for testing
• Environment Variables: Configured in Vercel dashboard

Local Development Environment

WeWrite uses branch-aware environment detection for local development:

• Main branch (main): Uses production collections - connects to real data
• Dev branch (dev): Uses dev collections (DEV_* prefix) - isolated test data
• Other branches: Uses dev collections (safe default) - isolated test data

This ensures you can test against production data when needed (main branch) while keeping development work safely isolated (dev branch).

Manual Deployment

# Build for production
pnpm build

# Deploy to Vercel
pnpm deploy

For detailed deployment procedures, see PRODUCTION_DEPLOYMENT_GUIDE.

🤝 Contributing

We welcome contributions! Please see our contributing guidelines:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Follow our coding standards (see documentation)
4. Write tests for new functionality
5. Submit a pull request

Development Guidelines

• Security First: Follow USERNAME_SECURITY_GUIDELINES
• Clean Code: Use LEGACY_CODE_CLEANUP_GUIDE
• Testing: Write comprehensive tests for all features
• Documentation: Update docs for any new features or changes

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

💬 Support

• 📧 Email: support@wewrite.app
• 💬 Discord: Join our community
• 🐛 Issues: GitHub Issues
• 📖 Documentation: docs/ directory

---

Made with ❤️ by the WeWrite team