Skip to content

README.md

Latest commit

 

History

History
66 lines (47 loc) · 1.47 KB

README.md

File metadata and controls

66 lines (47 loc) · 1.47 KB
Raw

Mini S3 Clone

A fully functional Amazon S3 clone implemented in Go using Fiber, GORM, MySQL, and Redis.
Supports file upload/download, bucket versioning, presigned URLs, and task queuing via Asynq.

Status

✅ Project Status: Fully Working
All core features have been implemented and tested. The system is stable and ready for production use. Contributions and feedback are welcome.

Features

Buckets

  • Create, list, get info, delete
  • Public or private ACLs
  • Optional versioning support

Files

  • Upload, download, delete
  • Versioned files
  • Presigned URLs for secure temporary access

Authentication

  • User signup and email verification
  • Secret key generation for presigned URLs

Tasks

  • Empty bucket
  • Copy bucket
  • Track task progress with percentage updates

Middleware

  • Authentication
  • Rate limiting via Redis
  • Presigned URL validation

Tech Stack

  • Backend: Go, Fiber, GORM
  • Database: MySQL (metadata storage)
  • Cache / Queue: Redis, Asynq
  • File Storage: Local disk (./storage)
  • Email: AWS SES for verification emails
  • Other: UUIDs, HMAC-SHA256 for presigned URLs

Installation

Prerequisites

  • Go 1.25+
  • Docker & Docker Compose
  • MySQL & Redis (can be run via Docker)
  • AWS credentials for SES (optional for email verification)

Clone the repository

git clone https://github.com/SysTechSalihY/mini-s3-clone.git
cd mini-s3-clone