本リポジトリはSFgenAIのフロントエンドのリポジトリである。
| 日付 | 改訂者 | 改訂内容 |
|---|---|---|
| 2025/04/28 | 今村 | 新規作成 |
| 2025/04/29 | 今村 | 環境構築手順を修正した。 |
| 2025/05/03 | 今村 | 開発環境と環境構築手順とNodeの内容を追記した。 |
主な開発環境の種類とバージョンは以下のとおりである。
- Mac
- Sonoma 4.6.1 (M1)
- Node
- v22.15.0
- Python
- 3.11.12
- Docker
- Docker version 20.10.17, build 100c701
- Google Chrome (Webブラウザ)
- 135.0.7049.115（Official Build） （arm64）
main：本リポジトリのマスターブランチ。リリースごとにdevelopをマージしていく。develop：開発機能をメインで取り込むブランチ。各機能の開発をマージする際はdevelopにマージすること。feature/xxx：新規機能を開発する際に指定するブランチ。fix/xxx：バグなどによる修正をする際に指定するブランチ。doc/xxx：ドキュメント系の作成や修正をする際に指定するブランチ。
状況に応じて上記を使い分けること。
上記に含まれないようなコミットをする場合は各々で適当なブランチ名とすること。
Docker Desktopをインストールする。
Windowsの場合：https://docs.docker.jp/desktop/install/windows-install.html
Macの場合：https://docs.docker.jp/desktop/install/mac-install.html
インストール後、以下のコマンドを実行して正常にインストールされたかを確認する。
$ docker -v
Docker version 20.10.17, build 100c701
$ docker-compose -v
Docker Compose version v2.10.2
以下のURLからそれぞれのOSに沿ったForkのインストーラーをダウンロードする。
※Gitクライアントについて、Forkを指定しているがSourceTreeなどでも可。
(自分の使いやすいものでOK)
以下のURLからNode.jsのv22.15.0をインストールする。
以下のURLからPythonの3.11.9をインストールする。(mock用)
本来は、3.11.12をインストールしたいが、以下を見る限り3.11.10 ~ 12のインストーラーはなさそう。
Forkの左のメニューにある「Repository」右クリックして、「Clone...」を選択する。
「URL」に「git@github.com:SFgenAI-dev2504/front.git」を記載し、適宜「Location」にクローン場所を記載する。
「Clone」ボタンをクリックする。
「Location」に指定した場所のソースコードがコピーされる。
以下のコマンドを実行して、イメージをビルドしてコンテナを起動する。(※基本初回のみ)
$ docker-compose up --build
http://127.0.0.1:3000 にWebブラウザでアクセスするとWebアプリの画面が表示される。
ソースを修正した後のコンテナに反映する場合は、以下のコマンドを実行する。
$ docker-compose restart web
Dockerコンテナの中でコマンドを実行したい場合は、以下のコマンドを実行する。
// webのコンテナ(フロントエンド)に入る場合
& docker-compose exec mock bash
// mockのコンテナ(バックエンドのmock用)に入る場合
$ docker-compose exec mock bash
以下のようにコンテナ内に入ることができる。
root@<コンテナID>:/app#
例えば、Node.jsやPythonのバージョン、ライブラリの一覧を見たい時などはコンテナ内で以下を実行する。
$ node --version
v22.15.0
$ python --version
Python 3.11.12
$ pip list
Package Version
---------------------- -------
blinker 1.9.0
click 8.1.8
Flask 2.3.3
Flask-SQLAlchemy 3.1.1
greenlet 3.2.1
itsdangerous 2.2.0
Jinja2 3.1.6
MarkupSafe 3.0.2
mysql-connector-python 8.3.0
pip 24.0
setuptools 65.5.1
SQLAlchemy 2.0.40
typing_extensions 4.13.2
Werkzeug 3.1.3
wheel 0.45.1
トラブルシューティングを記載する。
docker-compose up --build で「Error response from daemon: Ports are not available ... address already in use」が発生する
Macで以下のようなエラーが発生した場合、ControlCeという機能(Monterey以降実装された機能)が5000番ポートで起動されている可能性がある。
Error response from daemon: Ports are not available: exposing port TCP 0.0.0.0:5000 -> 0.0.0.0:0: listen tcp 0.0.0.0:5000: bind: address already in use
その場合は、Macの設定からAirPlayレシーバーの機能をオフにする。