Skip to content

クイックスタート

開発環境をセットアップするために、以下の手順に従ってください。

リポジトリをクローンする

NuxSaaS リポジトリをローカルマシンにクローンします:

bash
git clone https://github.com/NuxSaaS/NuxSaaS.git
cd NuxSaaS

Node.js v22 LTS を使用する

nvm を使って Node.js v22 LTS をインストールします:

bash
nvm use

このコマンドは .nvmrc ファイルを読み取り、指定された Node.js バージョン(v22 LTS)に切り替えます。

依存関係をインストールする

npm などお好みのパッケージマネージャーで依存関係をインストールします:

bash
npm install

環境変数を設定する

サンプルの環境ファイルをコピーし、ローカル設定を行います:

bash
cp .env.example .env

.env ファイルを編集して、データベースの認証情報や API キー(例: Stripe, Resend)、その他必要な設定を追加してください。

bash
# 説明: .env ファイルの例
NUXT_NITRO_PRESET=node-server # node-server または cloudflare-module

# Cloudflare Hyperdrive ID、cloudflare-module 使用時に必須
NUXT_CF_HYPERDRIVE_ID=cloudflare-hyperdrive-id

# アプリ
NUXT_APP_URL=http://localhost:3000 # アプリのベースURL
NUXT_APP_NAME=NuxSaaS
NUXT_APP_ENV=development
NUXT_APP_NOTIFY_EMAIL="[email protected]"
NUXT_APP_CONTACT_EMAIL="[email protected]"
NUXT_APP_REPO=https://github.com/NuxSaaS/NuxSaaS

NUXT_BETTER_AUTH_SECRET='' # JWT用のシークレットキー

# データベース、node-server プリセット使用時に必須
# nuxsaas という名前のデータベースを作成する必要があります(または任意の名前)
NUXT_DATABASE_URL=postgres://postgres:@localhost:5432/nuxsaas 
# Redis、node-server プリセット使用時に必須
NUXT_REDIS_URL=redis://localhost:6379

# GitHub
NUXT_GH_CLIENT_ID=your-github-client-id
NUXT_GH_CLIENT_SECRET=your-github-client-secret

# Google
NUXT_GOOGLE_CLIENT_ID=your-google-client-id
NUXT_GOOGLE_CLIENT_SECRET=your-google-client-secret

# Resend
NUXT_RESEND_API_KEY=your-resend-api-key

# Stripe
NUXT_STRIPE_SECRET_KEY=your-stripe-secret-key
NUXT_STRIPE_WEBHOOK_SECRET=your-stripe-webhook-key
NUXT_STRIPE_PRICE_ID_PRO_MONTH=your-stripe-price-id-pro-month
NUXT_STRIPE_PRICE_ID_PRO_YEAR=your-stripe-price-id-pro-year

データベースマイグレーションを生成・適用する

モデルに基づいてデータベーススキーマを生成し、マイグレーションを適用します:

bash
npm run db:generate
npm run db:migrate

開発サーバーを起動する

bash
npm run dev

アプリケーションはローカルで起動し、通常 http://localhost:3000 でアクセスできます。