mailbox/backend/README.md

64 lines
1.5 KiB
Markdown
Raw Normal View History

# 🖥️ Mailbox - Backend
이메일 송수신 및 관리를 위한 Node.js API 서버입니다.
![Node.js](https://img.shields.io/badge/Node.js-18+-339933?logo=node.js)
![Express](https://img.shields.io/badge/Express-4.x-000000?logo=express)
---
## 🛠️ 기술 스택
| 기술 | 설명 |
| -------------- | ------------- |
| **Node.js** | 런타임 환경 |
| **Express** | 웹 프레임워크 |
| **Sequelize** | ORM |
| **Nodemailer** | SMTP 전송 |
| **IMAP** | 이메일 수신 |
| **JWT** | 인증 |
---
## 📡 API 엔드포인트
### 인증
- `POST /api/auth/login` - 로그인
- `POST /api/auth/logout` - 로그아웃
### 이메일
- `GET /api/emails` - 이메일 목록
- `GET /api/emails/:id` - 이메일 상세
- `POST /api/emails/send` - 이메일 전송
- `DELETE /api/emails/:id` - 이메일 삭제
### 관리자
- `GET /api/admin/users` - 사용자 관리
- `GET /api/admin/dashboard` - 대시보드 통계
---
## 🚀 실행 방법
```bash
npm install
npm start
```
서버는 **포트 3000**에서 실행됩니다.
---
## ⚙️ 환경 변수
| 변수 | 설명 |
| ------------- | --------------------- |
| `DB_HOST` | 데이터베이스 호스트 |
| `DB_USER` | 데이터베이스 사용자 |
| `DB_PASSWORD` | 데이터베이스 비밀번호 |
| `DB_NAME` | 데이터베이스 이름 |
| `JWT_SECRET` | JWT 시크릿 키 |