mirror of
https://github.com/Afilmory/afilmory
synced 2026-04-24 23:05:05 +00:00
d5a2ea4db2
- Introduced a comprehensive `DEVELOPMENT.md` guide for contributors and self-hosters, detailing workspace layout and common commands. - Updated `README.md` to include links to the new development guide and improved deployment instructions. - Added new documentation files covering architecture, builder pipeline, configuration, and deployment strategies. - Implemented new storage provider documentation for Backblaze B2, Eagle, GitHub, and local storage options. - Enhanced the UI components with new features, including a navigation context and improved theme handling. - Removed outdated GitHub Action deployment documentation. Signed-off-by: Innei <tukon479@gmail.com>
77 lines
2.8 KiB
Plaintext
77 lines
2.8 KiB
Plaintext
---
|
|
title: Overview
|
|
description: Deploy a photo gallery in minutes—no database required.
|
|
createdAt: 2025-07-20T22:35:03+08:00
|
|
lastModified: 2025-11-23T19:40:52+08:00
|
|
order: 1
|
|
---
|
|
|
|
# Overview
|
|
|
|
Afilmory is a platform that transforms your photo collection into a fast, modern gallery. No database required—just point it at your photos and deploy.
|
|
|
|
## What is Afilmory?
|
|
|
|
Afilmory turns a photo folder (S3/B2/GitHub/local) into a fast, modern gallery. It processes your photos, generates thumbnails and metadata, and creates a beautiful web interface for browsing and viewing your collection.
|
|
|
|
## Key Features
|
|
|
|
- **WebGL-powered viewer** - Smooth zoom, pan, and navigation
|
|
- **Masonry grid layout** - Responsive photo grid with blurhash placeholders
|
|
- **Rich metadata** - EXIF data, Live Photo support, HDR detection, Fujifilm recipe details
|
|
- **Map view** - Visualize geotagged photos on an interactive map
|
|
- **SEO-ready** - Server-side rendering support for better discoverability
|
|
- **No database** - Everything runs from static files and manifests
|
|
|
|
## Prerequisites
|
|
|
|
Before you begin, make sure you have:
|
|
|
|
- **Git** installed
|
|
- **pnpm** package manager
|
|
- **Node.js 20+** installed
|
|
- Access to a photo source (S3/B2/GitHub/local/Eagle)
|
|
|
|
## Quick Start
|
|
|
|
Get your gallery running in 3 steps:
|
|
|
|
1. **Copy config**: `cp config.example.json config.json`, then set your name, links, and accent color
|
|
2. **Choose storage**: Go to [Storage Providers](/storage/providers) and configure your photo source
|
|
3. **Build and deploy**: Run `pnpm run build:manifest` to generate thumbnails and manifest, then deploy
|
|
|
|
For detailed instructions, see the [Quick Start Guide](/getting-started/quick-start).
|
|
|
|
## Deployment Options
|
|
|
|
Afilmory supports two deployment modes:
|
|
|
|
### Static Hosting (Easiest)
|
|
|
|
Publish your built files to any static host—GitHub Pages, Cloudflare Pages, or any CDN. No servers, no maintenance.
|
|
|
|
- **Best for**: Simple deployments, cost-effective hosting
|
|
- **Limitations**: Basic SEO, no server-rendered meta tags
|
|
|
|
### Server-Side Rendering (SSR)
|
|
|
|
Use the Next.js wrapper for enhanced SEO and Open Graph support. Deploy to Vercel or any Node.js host.
|
|
|
|
- **Best for**: Better SEO, social media previews, dynamic meta tags
|
|
- **Requirements**: Node.js runtime
|
|
|
|
See [Architecture](/architecture) for a detailed comparison.
|
|
|
|
## Next Steps
|
|
|
|
- **New to Afilmory?** Start with the [Quick Start Guide](/getting-started/quick-start)
|
|
- **Choose storage**: See [Storage Providers](/storage/providers) for setup instructions
|
|
- **Understand the system**: Read [Architecture](/architecture) to learn how it works
|
|
- **Deploy**: Follow the [Deployment Guide](/deployment) for your chosen platform
|
|
|
|
## Need Help?
|
|
|
|
- Check the [Storage Providers](/storage/providers) section for setup examples
|
|
- Review [Builder Commands](/builder) for common build operations
|
|
- File an issue on GitHub or check deployment guides for troubleshooting
|