環境構築は、Readmeを読むだけで構築できることが理想的ですが、パソコンの設定やOSによってうまく行かないことが多々あります。
プロジェクトの担当者に聞くのは、最終手段です。
今回は、環境構築で詰まった時に試していることをまとめます。
エラーメッセージを読む
エラーメッセージを読むことで、解決のヒントを得ることができます。
もし英語で出力された場合は、その文章を翻訳したり、エラー文を検索することでヒントを得ることができます。
※ChatGPTに、社内の情報を入力することは、情報漏洩のリスクがあるため気をつけましょう。
大体の場合、エラー文が次に何をするべきかを教えてくれます。
ドキュメントを読む
まず、関連するドキュメントが存在するかを確認します。
前任者が行ったトラブルシューティングが記載されている場合、それが解決のヒントになることがあります。
最初から試す
ファイルが見つからない場合や、起動が必要なものを起動していない場合など、手順に誤りがないかを疑います。
入力すべきコマンドを再度入力し直すことで解決する場合があります。
また、最初から環境構築の手順を見直すことで、うまくいくこともあります。
必要なライブラリやツールを確認する
Dockerのバージョンが古い場合や、指定されたNodeのバージョンがインストールされていない場合があります。
また、依存関係が原因で動作しないこともあります。
他に動いているプロジェクトがあるかを確認する
Dockerを使用している場合、以下のコマンドを入力することで、他のプロジェクトが動いているか確認できます。
$docker ps
また、Dockerのコンテナやイメージを削除することで解決することもあります。
フロントエンドの場合、使用するポートが他のプロジェクトで既に使われていることがよくあります。
その場合、一度すべてのプロジェクトを停止してから再度試すと、解決することがよくあります。
パソコンを再起動することも試す価値があります。
環境変数が設定されているかを確認する
環境変数が正しく設定されていない場合、当然ながら起動できません。
プロジェクトが進むにつれて環境変数が変更された場合、手順書が更新されていないとこのような問題が発生します。
もし、環境変数が原因であれば、直接プロジェクトの担当者に聞くしか解決できないと思います。
担当者に質問する
質問する時は、相手に状況をわかりやすく伝えてることが重要です。
自分が働いている環境では、AWSに関する技術的なお問い合わせについて、ガイドラインを読んでから質問するように指示されています。
少し難しいと感じるかもしれないですが、質問力が求められます。
まとめ
環境構築に失敗した場合、メモを残しておくことで、次に環境構築を行う人のためのトラブルシューティングになります。
最後に
ドキュメントのありがたみを感じます。