Add README.md with project documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
kihong.kim
2025-12-06 15:38:07 +09:00
parent 99ce8ccd0d
commit b535fe2636

87
README.md Normal file
View File

@@ -0,0 +1,87 @@
# BTC/USDT Real-time Trading View
바이낸스 API를 활용한 실시간 비트코인 트레이딩 뷰 웹 애플리케이션입니다.
## 주요 기능
- **실시간 차트**: 바이낸스 WebSocket을 통한 실시간 캔들스틱 차트
- **다양한 타임프레임**: 1분, 5분, 15분, 1시간, 4시간, 1일, 1주, 1월
- **기술적 지표**:
- 이동평균선 (MA5, MA20, MA60, MA120, MA200)
- 볼린저 밴드 (20, 2)
- MACD (12, 26, 9)
- RSI (14)
- 스토캐스틱 (14, 3, 3)
- 골든크로스/데드크로스 표시
- **실시간 분석 패널**: 각 지표별 매수/매도 신호 및 한글 분석 요약
## 기술 스택
- Vanilla JavaScript (프레임워크 없음)
- [Lightweight Charts](https://github.com/tradingview/lightweight-charts) by TradingView
- Binance WebSocket API
- Docker + Nginx
## 로컬 실행
```bash
# 간단한 HTTP 서버로 실행
npx http-server -p 3000
# 브라우저에서 접속
open http://localhost:3000
```
## Docker 배포
### 빌드 및 실행
```bash
# 이미지 빌드 및 컨테이너 실행
docker-compose up -d --build
# 로그 확인
docker-compose logs -f
# 중지
docker-compose down
```
### Caddy + Authentik 연동
`Caddyfile.example` 파일을 참고하여 Caddy 설정에 추가하세요.
```caddy
trading.yourdomain.com {
forward_auth authentik-server:9000 {
uri /outpost.goauthentik.io/auth/caddy
copy_headers X-Authentik-Username X-Authentik-Groups X-Authentik-Email
trusted_proxies private_ranges
}
reverse_proxy bini-trading-view:80
}
```
자세한 Authentik 설정 방법은 `Caddyfile.example` 파일 내 주석을 참고하세요.
## 프로젝트 구조
```
bini-trading-view/
├── index.html # 메인 HTML
├── styles.css # 스타일시트
├── app.js # 메인 애플리케이션 로직
├── indicators.js # 기술적 지표 계산 함수
├── Dockerfile # Docker 이미지 정의
├── docker-compose.yml # Docker Compose 설정
├── nginx.conf # Nginx 설정
└── Caddyfile.example # Caddy + Authentik 설정 예시
```
## 스크린샷
![Trading View](https://via.placeholder.com/800x450?text=BTC/USDT+Trading+View)
## 라이선스
MIT License