mailbox/README.md

93 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

# 📧 Mailbox
셀프 호스팅 이메일 클라이언트 애플리케이션입니다.
![React](https://img.shields.io/badge/React-18-61DAFB?logo=react)
![Node.js](https://img.shields.io/badge/Node.js-Express-339933?logo=node.js)
![Docker](https://img.shields.io/badge/Docker-2496ED?logo=docker)
---
## ✨ 주요 기능
- 📬 **이메일 송수신** - SMTP/IMAP 프로토콜 지원
- 🤖 **AI 번역** - Google Gemini API 연동
- 📎 **첨부파일** - S3 호환 스토리지 업로드
- 🔍 **고급 검색** - 다양한 필터 옵션
- 🛡️ **스팸 필터** - Rspamd 연동
- 👥 **다중 사용자** - 관리자 대시보드
---
## 📁 프로젝트 구조
```
mailbox/
├── frontend/ # React + Vite 프론트엔드
├── backend/ # Node.js + Express 백엔드
├── rspamd/ # 스팸 필터 설정
└── docker-compose.yml # Docker Compose 설정
```
---
## 🛠️ 기술 스택
### Frontend
| 기술 | 설명 |
| --------------- | -------------- |
| **React 18** | UI 라이브러리 |
| **Vite** | 빌드 도구 |
| **TailwindCSS** | CSS 프레임워크 |
### Backend
| 기술 | 설명 |
| -------------- | ------------- |
| **Node.js** | 런타임 환경 |
| **Express** | 웹 프레임워크 |
| **MariaDB** | 데이터베이스 |
| **Nodemailer** | 이메일 전송 |
| **IMAP** | 이메일 수신 |
### 인프라
| 기술 | 설명 |
| ---------- | ----------- |
| **Rspamd** | 스팸 필터링 |
| **Redis** | 캐시 서버 |
| **RustFS** | S3 스토리지 |
---
## 🚀 실행 방법
### Docker (권장)
```bash
docker compose up -d --build
```
### 개발 모드
```bash
# 백엔드
cd backend && npm install && npm start
# 프론트엔드
cd frontend && npm install && npm run dev
```
---
## 🌐 접속
- **URL**: https://mailbox.caadiq.co.kr
---
## 📄 라이선스
MIT License