Blueprint Documentation

Welcome to the Blueprint documentation. This central hub provides detailed information about the Blueprint platform, which serves as the central hub for Create Mod content.

Quick Navigation

• Getting Started - Installation and setup instructions
• Architecture - System architecture and data flow
• Features - Feature-specific documentation
• Contributing - Contribution guidelines

About Blueprint

Blueprint is a modern web platform that serves as the central hub for Create Mod content, bringing together community-made addons and player-designed schematics in one place. Our mission is to make Create Mod content more discoverable and manageable for the community.

Key Features

• 🔍 Addon Discovery: Browse, search and filter Create Mod addons with real-time updates
• 📁 Schematic Sharing: Upload and discover Create Mod contraption designs
• 👥 User Collections: Create and manage personalized addon collections
• 🔄 Version Compatibility: Smart filtering for Minecraft and Create Mod versions
• 🌐 Multi-Platform: Support for multiple mod loaders (Forge, Fabric, NeoForge)
• 🔒 Secure Authentication: OAuth integration with Discord, GitHub, and Google
• 🌙 Theme Support: Toggle between light and dark modes
• 🌍 Internationalization: Multi-language support with i18next
• 📱 Responsive Design: Optimized for all screen sizes

Documentation Structure

This documentation is organized into several sections:

• Getting Started - Essential information to set up and begin development
• Architecture - System design, data flow, and technical architecture
• Components - Reusable UI components and their usage
• Features - Detailed documentation for each major feature
• API - API integrations and custom endpoints
• Guides - Specific development guides and best practices
• Contributing - Guidelines for contributing to the project

Tech Stack

Blueprint is built with:

• Framework: React 19 with TypeScript
• Styling: Tailwind CSS, Shadcn/UI components
• State Management:
  • TanStack Query for server state
  • Zustand for local state
  • Signals for reactive state
• Backend Integration: Appwrite
• Search: Meilisearch
• Authentication: OAuth 2.0 with multiple providers
• Build Tool: Vite

Community

• Join our Discord Server
• Follow us on GitHub
• Report issues here

License

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