Skip to content

EmberlyOSS/Emberly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

104 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Emberly

Emberly is an open source platform for modern file storage, sharing, and identity verification. Build your digital presence with powerful tools for teams and individuals.

CodeRabbit Pull Request Reviews

Features

File Storage & Sharing

  • S3 compatible object storage with configurable upload limits
  • Secure file sharing with customizable access controls
  • Real world file organization and management
  • Bandwidth efficient delivery through global infrastructure

Domain & Branding

  • Custom domain support with annual registration
  • Personal or team branded file sharing pages
  • Domain SSL certificate management
  • DNS configuration assistance

Identity & Verification

  • User verification badges with multiple tier options
  • Verification queue with application review system
  • Badge display on public profiles
  • Organization verification for teams

Team & Collaboration

  • Squad based team subscriptions with seat based pricing
  • Granular permission management (roles: SUPPORT, DEVELOPER, MODERATOR, DESIGNER, STAFF)
  • Team member invitations and management
  • Shared storage pools with usage tracking

Applications & Trust

  • Staff application system for organizational partnerships
  • Partner program enrollment
  • Verification badge applications
  • Ban appeal process with review workflow
  • Email notifications for all application updates

Administrative Tools

  • Promo code management with configurable discounts
  • User management dashboard
  • Application review queue with multi stage triage
  • Service status monitoring via Kener integration
  • Analytics and usage reporting

Quick Start

For development setup, contribution guidelines, and detailed documentation, see CONTRIBUTING.md.

Prerequisites

  • Node.js 18+ or later
  • Bun package manager
  • PostgreSQL 14+ database
  • Redis 6+ (optional for caching)

Development Setup

# Clone the repository
git clone https://github.com/EmberlyOSS/Emberly.git
cd Emberly

# Install dependencies
bun install

# Configure environment
cp .env.template .env
# Edit .env with your configuration

# Initialize database
bun prisma generate
bun prisma migrate deploy

# Start development server
bun dev

The application will be available at http://localhost:3000.

Tech Stack

Frontend & Framework

Backend & Database

Infrastructure & Services

Development Tools

Project Structure

app/                     # Next.js App Router pages and routes
  (main)/                # Public user pages
  (raw)/                 # Raw file serving
  (shorturl)/            # Short URL redirects
  api/                   # API endpoints

packages/
  components/            # React components
    - admin/             # Admin dashboard components
    - pricing/           # Pricing and plans
    - auth/              # Authentication UI
    - dashboard/         # User dashboard
    - ui/                # Base UI building blocks
  
  hooks/                 # Custom React hooks
    - use file upload     # File uploading
    - use profile         # User profile data
    - use user content    # User content queries
  
  lib/                   # Utility functions
    - api/               # API helpers
    - auth/              # Authentication utilities
    - cache/             # Caching logic
    - stripe/            # Stripe integration
  
  types/                 # TypeScript definitions

prisma/                  # Database schema and migrations
  - schema.prisma        # Prisma schema definition
  - migrations/          # Migration files

public/                  # Static assets
scripts/                 # Build and utility scripts

Contributing

We welcome contributions from the community. Please see CONTRIBUTING.md for detailed guidelines including:

  • Development environment setup
  • Code standards and conventions
  • Pull request process
  • Commit message format
  • How to report issues
  • Community channels and support

Support

Get help and connect with the community:

  • Discord - Join our server for realtime discussions
  • GitHub Discussions - Ask questions and share ideas
  • Email - Contact hey@embrly.ca for support

License

This project is licensed under the GNU Affero General Public License v3 (AGPL-3.0). See the LICENSE file for details.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you agree to uphold this code. See CODE_OF_CONDUCT.md for the full text.

Acknowledgments

Thank you to all contributors who have helped make Emberly possible. We also appreciate the open source projects and communities that make this platform possible.

About

Emberly is an open source platform for modern file storage, sharing, and identity verification. Build your digital presence with powerful tools for teams and individuals.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

  •  
  •  

Contributors

Languages