Appearance

Developer Guide ​

Welcome ​

Welcome to the Collage Developer Guide. This comprehensive documentation covers both frontend applications in the Collage ecosystem, providing detailed guides, API references, and best practices for developers.

Applications ​

Admin-Frontend ​

The Admin-Frontend is a comprehensive Digital Asset Management (DAM) system built with Nuxt.js 2. It provides a robust platform for managing digital assets, folders, collages, user permissions, and workspace settings.

Key Features:

  • Digital Asset Management - Upload, organize, and manage digital assets
  • Advanced Search & Discovery - Full-text search with Typesense integration
  • Folder Operations - Complete folder management system
  • Asset Sharing & Permissions - Secure sharing with fine-grained access control
  • Multi-Workspace Support - Work across multiple workspaces
  • Real-time Notifications - System notifications and announcements
  • Cloud Storage Integration - AWS S3, Google Drive, Dropbox, Box

Tech Stack:

  • Framework: Nuxt.js 2.18.1
  • UI Library: Vuetify 1.12.3
  • State Management: Vuex
  • Search: Typesense
  • Storage: AWS S3

View Admin-Frontend Documentation →

Brand-Portal-Frontend ​

The Brand-Portal-Frontend is a modern, secure brand portal application built with Nuxt 4. It provides a comprehensive platform for brands to manage and share digital assets with their partners, dealers, and stakeholders. The application features a user-friendly interface with advanced search capabilities, real-time updates, and secure sharing mechanisms.

Key Features:

  • Dashboard & Homepage - Promotional banners, resource tiles, trending assets, and recent uploads
  • Advanced Search & Discovery - Full-text search with Typesense integration and advanced filtering
  • Asset Management - View, download, and manage digital assets with preview capabilities
  • Folder Management - Hierarchical folder navigation and organization
  • Collage Management - Create and manage collages (collections of assets)
  • Secure Sharing System - Share links with permissions, passwords, and expiration dates
  • Real-time Features - Live updates via Pusher WebSocket integration
  • Download System - Advanced download system for assets and folders

Tech Stack:

  • Framework: Nuxt 4.1.3
  • UI Library: Vuetify 3.10.5
  • State Management: Pinia 3.0.3
  • Search: Typesense 2.1.0
  • Real-time: Laravel Echo + Pusher
  • Language: TypeScript 5.9.3
  • Styling: SCSS

View Brand-Portal-Frontend Documentation →

Admin-Frontend ​

Brand-Portal-Frontend ​

Getting Started ​

  1. Choose Your Application - Select Admin-Frontend or Brand-Portal-Frontend above
  2. Explore Documentation - Navigate through Features, Components, Pages, and API sections
  3. Review Examples - Check code examples in component and feature documentation
  4. Follow Best Practices - Review development guidelines and patterns

Documentation Structure ​

This documentation is organized by application:

  • Admin-Frontend - Complete documentation for the DAM system
  • Brand-Portal-Frontend - Complete documentation for the brand portal application

Each application section includes:

  • Features - Core functionality and systems
  • Pages - Application pages and routes
  • Components - Reusable UI components
  • API Services - Backend integration
  • Middleware - Route protection
  • Store - State management
  • Mixins - Shared functionality
  • Utils - Helper functions

Need Help? ​

  • Check the detailed documentation in each section
  • Review code examples in component documentation
  • Refer to API endpoint documentation
  • Check middleware for access control patterns

Last Updated: 2024
Version: 1.0.0