Palmr.

Deprecated version documentation

This documentation refers to a previous version of Palmr. It may contain more complex configurations and bugs that have already been fixed.

View latest documentation (v3.0-beta)

Github Architecture

Project Structure

├── apps/
│   ├── web/         # Frontend application
│   ├── server/      # Backend API service
│   └── docs/        # Documentation site
└── composes/        # Docker compose configurations
configurations

Core Components

1. Frontend Application (apps/web)

Technology Stack:
  • React 18
  • TypeScript
  • Vite
  • HeroUI Components
  • TailwindCSS
  • i18next for internationalization
The frontend follows a feature-based architecture with:
  • Components-based structure
  • Custom hooks for business logic
  • Route protection system
  • File management system
  • Modal system for file operations

2. Backend Service (apps/server)

Technology Stack:
  • Fastify
  • PostgreSQL
  • MinIO for object storage
  • Prisma as ORM
Key features include:
  • User authentication/authorization
  • File management
  • Storage management
  • Share system

3. Documentation (apps/docs)

  • Built with Astro and Starlight
  • Provides comprehensive documentation for the project

4. Infrastructure

  • Docker-based deployment
  • Containerized services
  • Environment-specific configurations through docker-compose

Key Features

1. File Management
  • Upload/Download capabilities
  • File preview system
  • Share management
  • Storage usage monitoring
2. User System
  • Authentication
  • User management
  • Profile management
3. Storage System
  • MinIO integration for object storage
  • Disk space monitoring
  • Upload size validation
4. Internationalization
  • Multi-language support
  • Translation management