README.md

ft_transcendence

目次

• ft_transcendence
  • 目次
  • 使用技術について
    • nodeバージョン
    • フロントエンド
    • バックエンド
    • ミドルウェア
  • 環境構築
    • Visual Studio Code 拡張機能
    • クローン
    • 各環境の立ち上げ
    • アクセス方法
  • ディレクトリ構造
  • Gitの運用
    • ブランチについて
    • コミットメッセージの記法

使用技術について

nodeバージョン

• node v22.3.0
• npm v10.8.1

フロントエンド

• VanillaJS
• Bootstrap

バックエンド

• Django
• Solidity

ミドルウェア

• Docker
• Nginx
• PostgreSQL
• Docker-compose

(トップへ)

環境構築

Visual Studio Code 拡張機能

• Prettier
• Black Formatter
• Solidity

クローン

$ git clone https://github.com/M1n01/ft_transcendence.git

各環境の立ち上げ

# 環境変数ファイルの作成
$ cp .env.sample .env

# パッケージのインストール
$ npm install

# pre-commitの設定
$ pip install pre-commit
$ pre-commit install


# 環境の選択（以下のいずれかを実行）
$ make up   # ローカル環境
$ make dev  # dev環境
$ make      # 本番環境

アクセス方法

https://localhost:8000/ # ローカル環境
https://localhost:8001/ # dev環境
https://localhost/ # 本番環境

(トップへ)

ディレクトリ構造

$ tree . -L 3 -I "node_modules|doc|eth/node_modules"
.
├── Makefile
├── README.md
├── django
│   ├── backend
│   │   ├── accounts
│   │   ├── celerybeat-schedule
│   │   ├── db.sqlite3
│   │   ├── friend
│   │   ├── ft_trans
│   │   ├── lang.sh
│   │   ├── localization
│   │   ├── log
│   │   ├── make_db_setting.sh
│   │   ├── manage.py
│   │   ├── notification
│   │   ├── pong
│   │   ├── spa
│   │   └── tournament
│   ├── eth
│   ├── frontend
│   │   ├── package-lock.json
│   │   ├── package.json
│   │   ├── src
│   │   ├── webpack.common.js
│   │   ├── webpack.dev.js
│   │   └── webpack.prod.js
│   └── public
│       ├── media
│       ├── static
│       └── webpack-stats.json
├── docker
│   ├── db
│   │   ├── Dockerfile
│   │   ├── exe_sql.sh
│   │   ├── make_ca.sh
│   │   ├── postgresql.conf
│   │   └── sql_data
│   ├── django
│   │   ├── Dockerfile
│   │   ├── make_ca.sh
│   │   ├── make_db_setting.sh
│   │   └── package.json
│   ├── eth
│   │   └── Dockerfile
│   ├── nginx
│   │   ├── Dockerfile
│   │   ├── django.conf
│   │   └── make_ca.sh
│   └── redis
│       ├── Dockerfile
│       ├── make_ca.sh
│       └── tools
├── docker-compose.dev.yml
├── docker-compose.prod.yml
├── docker-compose.yml
├── document
│   ├── 42OAuth.drawio
│   ├── ft_trans_network.drawio
│   └── モジュール優先度.drawio
├── eslint.config.js
├── eth
│   ├── README.md
│   ├── artifacts
│   │   ├── @openzeppelin
│   │   ├── build-info
│   │   └── contracts
│   ├── cache
│   │   └── solidity-files-cache.json
│   ├── contract_address.txt
│   ├── contracts
│   │   └── PongScoreKeeper.sol
│   ├── hardhat.config.cjs
│   ├── package-lock.json
│   ├── package.json
│   ├── scripts
│   │   ├── deploy-local.js
│   │   └── deploy-sepolia.js
│   └── test
│       └── PongScoreKeeper.js
├── jsconfig.json
├── package-lock.json
└── package.json

35 directories, 48 files

(トップへ)

Gitの運用

ブランチについて

mainとfeatureブランチで運用する。

ブランチ名	役割	派生元	マージ先
main	本番環境	-	-
feature/*	機能開発	main	main

コミットメッセージの記法

fix: バグ修正
feat: 新機能追加
update: 機能更新
change: 仕様変更
perf: パフォーマンス改善
refactor: コードのリファクタリング
docs: ドキュメントのみの変更
style: コードのフォーマットに関する変更
test: テストコードの変更
revert: 変更の取り消し
chore: その他の変更

(トップへ)