mirror of
https://github.com/NoFxAiOS/nofx.git
synced 2026-06-06 05:51:19 +08:00
docs: complete ja and ko READMEs (#1206)
This commit is contained in:
@@ -86,13 +86,165 @@ cd web && npm run dev
|
||||
|
||||
---
|
||||
|
||||
## ライセンス
|
||||
## サーバー展開
|
||||
|
||||
**GNU Affero General Public License v3.0 (AGPL-3.0)**
|
||||
### クイックデプロイ (HTTP経由のIP)
|
||||
|
||||
デフォルトでは、トランスポート暗号化は**無効**になっており、HTTPSなしでIPアドレス経由でNOFXにアクセスできます:
|
||||
|
||||
```bash
|
||||
# サーバーにデプロイ
|
||||
curl -fsSL https://raw.githubusercontent.com/NoFxAiOS/nofx/main/install.sh | bash
|
||||
```
|
||||
|
||||
`http://YOUR_SERVER_IP:3000` 経由でアクセス - すぐに動作します。
|
||||
|
||||
### セキュリティ強化 (HTTPS)
|
||||
|
||||
セキュリティを強化するには、`.env`でトランスポート暗号化を有効にします:
|
||||
|
||||
```bash
|
||||
TRANSPORT_ENCRYPTION=true
|
||||
```
|
||||
|
||||
有効にすると、ブラウザはWeb Crypto APIを使用して転送前にAPIキーを暗号化します。これには以下が必要です:
|
||||
- `https://` - SSLを備えた任意のドメイン
|
||||
- `http://localhost` - ローカル開発
|
||||
|
||||
### Cloudflareを使用した簡単なHTTPSセットアップ
|
||||
|
||||
1. **ドメインをCloudflareに追加** (無料プランでOK)
|
||||
- [dash.cloudflare.com](https://dash.cloudflare.com) にアクセス
|
||||
- ドメインを追加してネームサーバーを更新
|
||||
|
||||
2. **DNSレコードを作成**
|
||||
- タイプ: `A`
|
||||
- 名前: `nofx` (またはサブドメイン)
|
||||
- コンテンツ: サーバーのIP
|
||||
- プロキシ状態: **Proxied** (オレンジ色の雲)
|
||||
|
||||
3. **SSL/TLSを設定**
|
||||
- SSL/TLS設定に移動
|
||||
- 暗号化モードを **Flexible** に設定
|
||||
|
||||
```
|
||||
User ──[HTTPS]──→ Cloudflare ──[HTTP]──→ Your Server:3000
|
||||
```
|
||||
|
||||
4. **トランスポート暗号化を有効化**
|
||||
```bash
|
||||
# .envを編集して設定
|
||||
TRANSPORT_ENCRYPTION=true
|
||||
```
|
||||
|
||||
5. **完了!** `https://nofx.yourdomain.com` 経由でアクセス
|
||||
|
||||
---
|
||||
|
||||
## 初期設定 (Webインターフェース)
|
||||
|
||||
システムを起動した後、Webインターフェースを通じて設定します:
|
||||
|
||||
1. **AIモデルの設定** - AI APIキーを追加 (DeepSeek、OpenAI など)
|
||||
2. **取引所の設定** - 取引所API認証情報を設定
|
||||
3. **戦略の作成** - ストラテジースタジオで取引戦略を設定
|
||||
4. **トレーダーの作成** - AIモデル + 取引所 + 戦略を組み合わせ
|
||||
5. **取引開始** - 設定したトレーダーを起動
|
||||
|
||||
すべての設定はWebインターフェースで完了 - JSONファイルの編集は不要です。
|
||||
|
||||
---
|
||||
|
||||
## Webインターフェース機能
|
||||
|
||||
### 競争ページ
|
||||
- リアルタイムROIリーダーボード
|
||||
- マルチAIパフォーマンス比較チャート
|
||||
- ライブ損益追跡とランキング
|
||||
|
||||
### ダッシュボード
|
||||
- TradingViewスタイルのローソク足チャート
|
||||
- リアルタイムポジション管理
|
||||
- Chain of Thought推論付きAI決定ログ
|
||||
- エクイティカーブ追跡
|
||||
|
||||
### ストラテジースタジオ
|
||||
- コインソース設定 (静的リスト、AI500プール、OI Top)
|
||||
- テクニカル指標 (EMA、MACD、RSI、ATR、出来高、OI、資金調達率)
|
||||
- リスク管理設定 (レバレッジ、ポジション制限、証拠金使用率)
|
||||
- リアルタイムプロンプトプレビュー付きAIテスト
|
||||
|
||||
---
|
||||
|
||||
## よくある問題
|
||||
|
||||
### TA-Libが見つからない
|
||||
```bash
|
||||
# macOS
|
||||
brew install ta-lib
|
||||
|
||||
# Ubuntu
|
||||
sudo apt-get install libta-lib0-dev
|
||||
```
|
||||
|
||||
### AI APIタイムアウト
|
||||
- APIキーが正しいか確認
|
||||
- ネットワーク接続を確認
|
||||
- システムタイムアウトは120秒
|
||||
|
||||
### フロントエンドがバックエンドに接続できない
|
||||
- バックエンドが http://localhost:8080 で実行されているか確認
|
||||
- ポートが占有されていないか確認
|
||||
|
||||
---
|
||||
|
||||
## ライセンス
|
||||
|
||||
このプロジェクトは **GNU Affero General Public License v3.0 (AGPL-3.0)** の下でライセンスされています - [LICENSE](LICENSE) ファイルを参照してください。
|
||||
|
||||
---
|
||||
|
||||
## 貢献
|
||||
|
||||
貢献を歓迎します!以下を参照してください:
|
||||
- **[貢献ガイド](CONTRIBUTING.md)** - 開発ワークフローとPRプロセス
|
||||
- **[行動規範](CODE_OF_CONDUCT.md)** - コミュニティガイドライン
|
||||
- **[セキュリティポリシー](SECURITY.md)** - 脆弱性の報告
|
||||
|
||||
---
|
||||
|
||||
## 貢献者エアドロッププログラム
|
||||
|
||||
すべての貢献はGitHubで追跡されます。NOFXが収益を生み出すと、貢献者は貢献に基づいてエアドロップを受け取ります。
|
||||
|
||||
**[ピン留めされたIssue](https://github.com/NoFxAiOS/nofx/issues)を解決するPRは最高報酬を受け取ります!**
|
||||
|
||||
| 貢献タイプ | 重み |
|
||||
|------------------|:------:|
|
||||
| **ピン留めIssue PR** | ⭐⭐⭐⭐⭐⭐ |
|
||||
| **コードコミット** (マージされたPR) | ⭐⭐⭐⭐⭐ |
|
||||
| **バグ修正** | ⭐⭐⭐⭐ |
|
||||
| **機能提案** | ⭐⭐⭐ |
|
||||
| **バグ報告** | ⭐⭐ |
|
||||
| **ドキュメント** | ⭐⭐ |
|
||||
|
||||
---
|
||||
|
||||
## リスク警告
|
||||
|
||||
1. 暗号通貨市場は非常に変動が激しい - AIの決定は利益を保証しない
|
||||
2. 先物取引はレバレッジを使用 - 損失は元本を超える可能性がある
|
||||
3. 極端な市場状況では清算リスクがある
|
||||
|
||||
|
||||
|
||||
## コンタクト
|
||||
|
||||
- **GitHub Issues**: [Issue を提出](https://github.com/NoFxAiOS/nofx/issues)
|
||||
- **開発者コミュニティ**: [Telegram グループ](https://t.me/nofx_dev_community)
|
||||
|
||||
---
|
||||
|
||||
## Star History
|
||||
|
||||
[](https://star-history.com/#NoFxAiOS/nofx&Date)
|
||||
|
||||
@@ -86,13 +86,166 @@ cd web && npm run dev
|
||||
|
||||
---
|
||||
|
||||
## 라이선스
|
||||
## 서버 배포
|
||||
|
||||
**GNU Affero General Public License v3.0 (AGPL-3.0)**
|
||||
### 빠른 배포 (IP를 통한 HTTP)
|
||||
|
||||
기본적으로 전송 암호화가 **비활성화**되어 HTTPS 없이 IP 주소를 통해 NOFX에 액세스할 수 있습니다:
|
||||
|
||||
```bash
|
||||
# 서버에 배포
|
||||
curl -fsSL https://raw.githubusercontent.com/NoFxAiOS/nofx/main/install.sh | bash
|
||||
```
|
||||
|
||||
`http://YOUR_SERVER_IP:3000`을 통해 액세스 - 즉시 작동합니다.
|
||||
|
||||
### 향상된 보안 (HTTPS)
|
||||
|
||||
보안을 강화하려면 `.env`에서 전송 암호화를 활성화하세요:
|
||||
|
||||
```bash
|
||||
TRANSPORT_ENCRYPTION=true
|
||||
```
|
||||
|
||||
활성화되면 브라우저는 Web Crypto API를 사용하여 전송 전에 API 키를 암호화합니다. 이를 위해 필요한 것:
|
||||
- `https://` - SSL이 있는 모든 도메인
|
||||
- `http://localhost` - 로컬 개발
|
||||
|
||||
### Cloudflare를 사용한 빠른 HTTPS 설정
|
||||
|
||||
1. **Cloudflare에 도메인 추가** (무료 플랜 가능)
|
||||
- [dash.cloudflare.com](https://dash.cloudflare.com) 방문
|
||||
- 도메인 추가 및 네임서버 업데이트
|
||||
|
||||
2. **DNS 레코드 생성**
|
||||
- 유형: `A`
|
||||
- 이름: `nofx` (또는 서브도메인)
|
||||
- 콘텐츠: 서버 IP
|
||||
- 프록시 상태: **Proxied** (주황색 구름)
|
||||
|
||||
3. **SSL/TLS 구성**
|
||||
- SSL/TLS 설정으로 이동
|
||||
- 암호화 모드를 **Flexible**로 설정
|
||||
|
||||
```
|
||||
User ──[HTTPS]──→ Cloudflare ──[HTTP]──→ Your Server:3000
|
||||
```
|
||||
|
||||
4. **전송 암호화 활성화**
|
||||
```bash
|
||||
# .env 편집 및 설정
|
||||
TRANSPORT_ENCRYPTION=true
|
||||
```
|
||||
|
||||
5. **완료!** `https://nofx.yourdomain.com`을 통해 액세스
|
||||
|
||||
---
|
||||
|
||||
## 초기 설정 (웹 인터페이스)
|
||||
|
||||
시스템을 시작한 후 웹 인터페이스를 통해 구성합니다:
|
||||
|
||||
1. **AI 모델 구성** - AI API 키 추가 (DeepSeek, OpenAI 등)
|
||||
2. **거래소 구성** - 거래소 API 자격 증명 설정
|
||||
3. **전략 생성** - 전략 스튜디오에서 거래 전략 구성
|
||||
4. **트레이더 생성** - AI 모델 + 거래소 + 전략 결합
|
||||
5. **거래 시작** - 구성된 트레이더 시작
|
||||
|
||||
모든 구성은 웹 인터페이스를 통해 완료 - JSON 파일 편집 불필요.
|
||||
|
||||
---
|
||||
|
||||
## 웹 인터페이스 기능
|
||||
|
||||
### 경쟁 페이지
|
||||
- 실시간 ROI 리더보드
|
||||
- 다중 AI 성능 비교 차트
|
||||
- 실시간 손익 추적 및 순위
|
||||
|
||||
### 대시보드
|
||||
- TradingView 스타일 캔들스틱 차트
|
||||
- 실시간 포지션 관리
|
||||
- Chain of Thought 추론이 포함된 AI 결정 로그
|
||||
- 자본 곡선 추적
|
||||
|
||||
### 전략 스튜디오
|
||||
- 코인 소스 구성 (정적 목록, AI500 풀, OI Top)
|
||||
- 기술 지표 (EMA, MACD, RSI, ATR, 거래량, OI, 펀딩 비율)
|
||||
- 리스크 제어 설정 (레버리지, 포지션 한도, 마진 사용)
|
||||
- 실시간 프롬프트 미리보기를 포함한 AI 테스트
|
||||
|
||||
---
|
||||
|
||||
## 일반적인 문제
|
||||
|
||||
### TA-Lib을 찾을 수 없음
|
||||
```bash
|
||||
# macOS
|
||||
brew install ta-lib
|
||||
|
||||
# Ubuntu
|
||||
sudo apt-get install libta-lib0-dev
|
||||
```
|
||||
|
||||
### AI API 타임아웃
|
||||
- API 키가 올바른지 확인
|
||||
- 네트워크 연결 확인
|
||||
- 시스템 타임아웃은 120초
|
||||
|
||||
### 프론트엔드가 백엔드에 연결할 수 없음
|
||||
- 백엔드가 http://localhost:8080에서 실행 중인지 확인
|
||||
- 포트가 점유되어 있지 않은지 확인
|
||||
|
||||
---
|
||||
|
||||
## 라이선스
|
||||
|
||||
이 프로젝트는 **GNU Affero General Public License v3.0 (AGPL-3.0)** 라이선스에 따라 제공됩니다 - [LICENSE](LICENSE) 파일을 참조하세요.
|
||||
|
||||
---
|
||||
|
||||
## 기여
|
||||
|
||||
기여를 환영합니다! 다음을 참조하세요:
|
||||
- **[기여 가이드](CONTRIBUTING.md)** - 개발 워크플로 및 PR 프로세스
|
||||
- **[행동 강령](CODE_OF_CONDUCT.md)** - 커뮤니티 가이드라인
|
||||
- **[보안 정책](SECURITY.md)** - 취약점 보고
|
||||
|
||||
---
|
||||
|
||||
## 기여자 에어드롭 프로그램
|
||||
|
||||
모든 기여는 GitHub에서 추적됩니다. NOFX가 수익을 창출하면 기여자는 기여도에 따라 에어드롭을 받게 됩니다.
|
||||
|
||||
**[고정된 Issue](https://github.com/NoFxAiOS/nofx/issues)를 해결하는 PR은 최고 보상을 받습니다!**
|
||||
|
||||
| 기여 유형 | 가중치 |
|
||||
|------------------|:------:|
|
||||
| **고정된 Issue PR** | ⭐⭐⭐⭐⭐⭐ |
|
||||
| **코드 커밋** (병합된 PR) | ⭐⭐⭐⭐⭐ |
|
||||
| **버그 수정** | ⭐⭐⭐⭐ |
|
||||
| **기능 제안** | ⭐⭐⭐ |
|
||||
| **버그 보고** | ⭐⭐ |
|
||||
| **문서** | ⭐⭐ |
|
||||
|
||||
---
|
||||
|
||||
## 위험 경고
|
||||
|
||||
1. 암호화폐 시장은 매우 변동성이 높음 - AI 결정이 수익을 보장하지 않음
|
||||
2. 선물 거래는 레버리지 사용 - 손실이 원금을 초과할 수 있음
|
||||
3. 극단적인 시장 상황에서 청산 위험 있음
|
||||
|
||||
|
||||
|
||||
|
||||
## 연락처
|
||||
|
||||
- **GitHub Issues**: [Issue 제출](https://github.com/NoFxAiOS/nofx/issues)
|
||||
- **개발자 커뮤니티**: [Telegram 그룹](https://t.me/nofx_dev_community)
|
||||
|
||||
---
|
||||
|
||||
## Star History
|
||||
|
||||
[](https://star-history.com/#NoFxAiOS/nofx&Date)
|
||||
|
||||
Reference in New Issue
Block a user