開発環境のセットアップ¶

前提条件¶

開発を始める前に、以下のツールをインストールする必要があります：

開発環境¶

開発を始めるには、リポジトリをクローンし依存関係をインストールします：

git clone https://github.com/oqtopus-team/oqtopus-cloud.git

Aquaのインストール¶

Aquaはプロジェクトの管理をサポートするツールです。 詳細は こちらで確認できます。

Aquaをインストールするには、以下のコマンドを実行します：

make setup-aqua

このコマンドの最後に出てくるメッセージでaquaをPATHに追加するように指示されますので従ってください。

環境の確認¶

環境を確認するには、以下のコマンドを実行します：

make doctor

上記の手順を実行すると、以下のような出力が得られます：

make doctor
Checking the environment...
Aqua version: aqua version 2.29.0 (9ff65378f0c6197e3130a20f6d978b8a3042b463)
Python version: Python 3.12.3
Poetry version: Poetry (version 1.8.3)
Docker version: Docker version 26.1.4, build 5650f9b

Gitフックファイルの生成¶

このリポジトリでは、クレデンシャルをスキャンするためにGitフック pre-commit を使用します。

スクリプトを生成するには、以下のコマンドを実行してください：

make setup-hooks

スクリプトは .git/hooks/pre-commitに生成されます。

Python環境のセットアップ¶

Pyenv(推奨)¶

Python 3.12.3をインストールするには、以下のコマンドを実行します：

pyenv install 3.12.3

次に、Pythonのバージョンを3.12.3に設定します：

pyenv local 3.12.3

Poetry¶

環境設定の一環でpoetryを設定するために、以下のコマンドを実行します：

make setup-poetry

このコマンドは、PyenvでインストールされたPythonバージョンの使用、Python環境のセットアップ、依存関係のインストールに必要です。これにより、ルートディレクトリに .venv が作成されます。

ドキュメンテーションサーバーの起動¶

ドキュメンテーションサーバーを起動するには、以下のコマンドを実行します：

make run

その後、http://localhost:8000 でドキュメンテーションを確認します。