LEARN.md

Learning Resources for FileDuck

📚 Overview

This document contains learning resources, tutorials, and guides for understanding and contributing to FileDuck.

🎯 Core Technologies

Frontend

• Vue 3 - Progressive JavaScript framework
  • Official Documentation
  • Composition API Guide
• TypeScript - Type-safe JavaScript
  • TypeScript Handbook
• Vite - Next-generation build tool
  • Getting Started

Backend

• Node.js - JavaScript runtime
  • Node.js Best Practices
• Express - Web framework for Node.js
  • Express Guide

Storage & CDN

• GitHub Releases - Primary storage backend
  • GitHub REST API
• AWS S3 - Object storage
  • S3 Developer Guide
• CloudFront - CDN for global distribution
  • CloudFront Documentation

Database & Caching

• Redis - In-memory data store
  • Redis Commands
  • Redis Best Practices

Security

• ClamAV - Antivirus engine
  • ClamAV Documentation
• VirusTotal - File scanning API
  • VirusTotal API

🏗️ Architecture Concepts

Monorepo Structure

Learn about monorepo management with Turborepo:

• Turborepo Handbook
• PNPM Workspaces

File Upload Strategies

• Multipart Upload - Splitting large files into chunks
• Presigned URLs - Secure direct uploads to S3/GitHub
• Resumable Uploads - Handling interrupted transfers

Security Patterns

• Zero-Knowledge Architecture - Client-side encryption
• One-Time Codes - Single-use access tokens
• Rate Limiting - Protecting against abuse

🛠️ Development Workflow

Getting Started

1. Review ARCHITECTURE.md for system design
2. Check CONTRIBUTING.md for contribution guidelines
3. Read SECURITY.md for security practices

Local Development

# Install dependencies
pnpm install

# Start development servers
pnpm dev

# Run tests
pnpm test

# Build for production
pnpm build

Code Quality

• ESLint - Linting JavaScript/TypeScript
• Prettier - Code formatting
• TypeScript - Type checking

📖 Recommended Reading

Web Development

• MDN Web Docs
• Web.dev

Cloud & DevOps

• The Twelve-Factor App
• Docker Best Practices

Security

• OWASP Top 10
• Web Security Academy

🎓 Tutorials & Guides

Building Similar Features

• File Upload with Progress: Learn about XMLHttpRequest and FormData
• Client-Side Encryption: Explore Web Crypto API
• Real-time Updates: WebSockets and Server-Sent Events
• Progressive Web Apps: Service Workers and offline functionality

Performance Optimization

• Code Splitting: Lazy loading routes and components
• Image Optimization: Compression and lazy loading
• Caching Strategies: Browser cache, CDN, and Redis

🤝 Community & Support

• GitHub Issues: Report bugs or request features
• Discussions: Share ideas and ask questions
• Discord/Slack: Join our community (if available)

📝 Next Steps

1. Explore the Codebase: Start with apps/vue-app/src/ and apps/api/
2. Run Locally: Follow the Quick Start guide in README.md
3. Make Small Changes: Fix typos, update docs, add comments
4. Build Features: Pick an issue labeled "good first issue"
5. Share Knowledge: Write tutorials, create videos, help others

---

Happy Learning! 🚀

For questions or suggestions about these learning resources, please open an issue or submit a pull request.