Files
akiyama-manga/PROJECT_SUMMARY.md

3.3 KiB

Akiyama Manga - Complete Project Setup

I've created a comprehensive manga hosting platform written in Go with S3 integration, similar to yorai.io. Here's what's been set up:

🎨 Design & Frontend

  • Dark theme UI inspired by yorai.io with modern gradients
  • Responsive grid layout for manga browsing
  • Search and filter functionality
  • User authentication pages (sign in/sign up)
  • Manga library management interface
  • Clean navigation with search bar

🔧 Backend (Go)

  • Gin web framework for fast HTTP routing
  • GORM for database ORM with auto-migrations
  • PostgreSQL support with full schema
  • JWT authentication for user sessions
  • S3 integration for manga storage (supports AWS, MinIO, DigitalOcean Spaces, etc.)

📦 Database Models

  • Users with profiles and authentication
  • Mangas with metadata, cover images, and status
  • Chapters with page counts
  • Pages stored in S3 with URLs
  • User reviews and ratings
  • Genre/tag system
  • User library (many-to-many relationship)

☁️ S3 Integration

  • Upload manga covers to S3
  • Store chapter pages in S3
  • Support for custom S3 endpoints (AWS, MinIO, DigitalOcean, Linode, etc.)
  • Folder structure: covers/, manga/, avatars/

📚 Comprehensive Documentation

  • README.md - Project overview and features
  • QUICKSTART.md - Get running in 5 minutes
  • DATABASE_SETUP.md - PostgreSQL setup guide
  • S3_SETUP.md - AWS S3 and alternatives configuration
  • API.md - Complete API documentation with examples
  • DEPLOYMENT.md - Production deployment guide
  • CONTRIBUTING.md - Development guidelines

🚀 Deployment Ready

  • Docker & Docker Compose setup
  • Makefile for common tasks
  • Systemd service template for Linux
  • Nginx reverse proxy config
  • Kubernetes manifests example
  • Support for Heroku, Railway, DigitalOcean

📁 Project Structure

akiyama-manga/
├── cmd/server/          # Main application entry
├── internal/
│   ├── auth/           # JWT & password hashing
│   ├── database/       # PostgreSQL setup
│   ├── handlers/       # HTTP endpoints
│   ├── middleware/     # CORS, auth, logging
│   ├── models/         # Data structures
│   ├── services/       # Business logic
│   └── storage/        # S3 integration
├── web/frontend/       # HTML, CSS, JS
├── Makefile            # Build automation
├── Dockerfile          # Container image
└── docker-compose.yml  # Full stack setup

Key Features

Browse and search mangas User authentication with JWT Rate and review system Personal manga library S3/custom storage integration Auto-database migrations Dark theme UI (yorai.io style) Responsive design (mobile-friendly) Docker deployment Production-ready

🚀 Get Started

Quick Start (5 minutes):

cd d:\Projects\akiyama-manga
copy .env.example .env
# Edit .env with your S3 credentials
docker-compose up
# Visit http://localhost:8080

Manual Setup:

  1. Read QUICKSTART.md for step-by-step instructions
  2. Set up PostgreSQL using DATABASE_SETUP.md
  3. Configure S3 using S3_SETUP.md
  4. Run go run cmd/server/main.go

All files are ready in d:\Projects\akiyama-manga/! You can start developing right away.