Contents
HerokuでNode.jsアプリをデプロイする手順
Heroku上でNode.jsアプリケーションをデプロイするには、プロジェクト構成や環境設定の知識が不可欠です。本記事では、公式ドキュメントに準拠した手順と必要な技術的注意点を解説します。具体的なコマンド例や設定方法を含めて、初心者でも理解しやすいステップバイステップでご紹介します。
Herokuデプロイ前の準備
Herokuへのデプロイは、事前準備がしっかり行われていないと失敗する可能性があります。アカウント作成からローカル環境の確認まで、以下の手順を確実に進めましょう。
Herokuアカウントの作成
Heroku利用には無料アカウント登録が必要です。公式サイトで簡単な手続きで完了します。
- https://signup.heroku.com にアクセスし、メールアドレスとパスワードを入力します。
- メール認証を行い、アカウントを有効化します。
- Heroku CLIのインストール後、
heroku loginコマンドでログインします。
注意: 公式ドキュメントに基づいて手順を進めることが推奨されます。
ローカル環境の確認と準備
デプロイ前には、ローカルのHeroku CLIやnpmが正常に動作しているかを確認してください。
- Heroku CLI:
heroku --versionで最新バージョンを確認します(現時点では8.1.x以上推奨)。 - npm:
npm -vで現在のバージョンを確認し、必要に応じて更新します(例:npm install -g npm)。
| 項目 | 必要バージョン | 補足 |
|---|---|---|
| Heroku CLI | 8.1.x以上 | heroku --versionで確認 |
| npm | 最新版 | npm -vで確認 |
プロジェクト構成の基本設定
HerokuはProcfileとpackage.jsonをもとにアプリケーションを起動します。これらのファイルを作成・設定する必要があります。
Procfileの作成
ProcfileはHerokuがアプリケーションを起動する際の指示書です。以下のように設定します。
- プロジェクトルートに
Procfile(拡張子なし)を作成します。 - 内容を以下の例に設定します:
text
web: node app.js
注意:
app.jsは実際のエントリーポイントに置き換えてください。
package.jsonの設定
package.jsonにはアプリケーションの起動スクリプトを記載します。特にstartスクリプトは必須です。
-
startスクリプト:
json
"scripts": {
"start": "node app.js"
} -
開発用スクリプト(任意):
json
"scripts": {
"start": "node app.js",
"dev": "nodemon app.js"
}
Heroku CLIによるデプロイ手順
Heroku CLIを使用してアプリケーションを公開する際の具体的なコマンドと手順です。
gitリポジトリへの登録
アプリケーションがgitで管理されていない場合は、以下の手順で準備します。
-
プロジェクトルートで以下を実行:
bash
git init -
.gitignoreファイルを作成し、不要なファイル(例:node_modules/)を除外します。
heroku createコマンドの実行
Herokuにアプリケーションを新規作成します。
-
以下のコマンドでリモートリポジトリを追加:
bash
heroku create your-app-name -
https://your-app-name.herokuapp.comが生成され、デプロイ後のURLとなります。
git pushによる本番環境への配備
ローカルのコードをHerokuに反映します。
-
変更を追加:
bash
git add . -
コミットして保存:
bash
git commit -m "Deploy to Heroku" -
Herokuにプッシュします:
bash
git push heroku main
トラブルシューティング: エラーが発生する場合、
heroku logs --tailでリアルタイムログを確認してください。
環境変数とNode.jsバージョンの設定
アプリケーションに必要な環境変数やNode.jsバージョンの指定方法について解説します。
Config Varsの設定
シークレット情報(APIキーなど)は、Config Varsで管理する必要があります。
-
CLIから以下を実行:
bash
heroku config:set API_KEY=your_api_key -
またはHerokuダッシュボードから「Settings」→「Reveal Config Vars」で設定可能です。
Node.jsバージョンの指定
特定のNode.jsバージョンを使用するには、以下のようにします。
-
package.jsonに
enginesを追加:
json
"engines": {
"node": "20.x"
} -
.nvmrcファイルを作成(例:20.13.0)。
デプロイ後の確認と完了
デプロイが終わったら、アプリケーションの動作やログをチェックします。
アプリ起動の確認
以下のコマンドでアプリケーションが正常に起動しているか確認します:
|
1 2 |
heroku open |
ログの確認方法
トラブルシューティングには、以下のようにしてリアルタイムログを参照できます:
-
実行コマンド:
bash
heroku logs --tail -
リアルタイム出力が表示されるため、デバッグに非常に便利です。
まとめと補足情報
本記事では、HerokuでのNode.jsアプリケーションのデプロイに関する基本的な手順を解説しました。準備作業からログ確認までを網羅し、初心者でも理解できるよう工夫しています。
- Herokuアカウント登録からCLI使用までの一連の流れを解説。
Procfileやpackage.jsonの設定手順を具体例で紹介。- 環境変数やNode.jsバージョン指定などの実務的な知識も加えました。
Heroku公式ドキュメントを参考に、さらに技術的詳細を深掘りしてみてください。