設定リファレンス

プロジェクトの設定項目について記載します。

環境変数

設定可能な環境変数について説明します。

基本設定

変数名

説明

デフォルト値

必須

PROJECT_NAME

プロジェクト名

-

Yes

DEBUG

デバッグモード

false

No

PORT

ポート番号

3000

No

データベース設定

変数名

説明

デフォルト値

必須

DATABASE_URL

データベース接続URL

-

Yes

DB_POOL_SIZE

コネクションプール数

10

No

外部サービス設定

変数名

説明

デフォルト値

必須

API_KEY

外部API キー

-

Yes

SECRET_KEY

暗号化キー

-

Yes

設定ファイル

設定ファイルの形式と項目について説明します。

config.json

{
  "app": {
    "name": "Project Name",
    "version": "1.0.0"
  },
  "server": {
    "port": 3000,
    "host": "localhost"
  },
  "database": {
    "type": "postgresql",
    "host": "localhost",
    "port": 5432
  }
}

設定の優先順位

設定値の優先順位について説明します。

  1. 環境変数

  2. 設定ファイル

  3. デフォルト値