w
ドキュメント ようこそ Get Started

インストールガイド

このガイドでは、プラットフォームを迅速にインストールして設定する方法を説明します。

システム要件

最小要件

  • Node.js: 18.0.0以上
  • npm: 8.0.0以上
  • pnpm: 8.0.0以上（推奨）
  • メモリ: 4GB RAM
  • ストレージ: 2GBの空き容量

推奨設定

  • Node.js: 20.0.0以上
  • メモリ: 8GB RAM
  • ストレージ: 5GBの空き容量
  • オペレーティングシステム: macOS 12+, Ubuntu 20.04+, Windows 10+

インストール手順

1. プロジェクトのクローン

git clone https://github.com/your-org/woker-job.git
cd woker-job

2. 依存関係のインストール

pnpmを使用（推奨）：

pnpm install

またはnpmを使用：

npm install

3. 環境設定

環境変数ファイルをコピー：

cp .env.example .env

.envファイルを編集して必要な環境変数を設定：

# データベース設定
DATABASE_URL="postgresql://username:password@localhost:5432/woker_job"

# JWTシークレット
JWT_SECRET="your-jwt-secret-key"

# フロントエンド設定
NUXT_PUBLIC_FRONTEND_BASE_URL="http://localhost:3000"
NUXT_PUBLIC_BACKEND_BASE_URL="http://localhost:3001"

4. データベース設定

Dockerを使用（推奨）

# PostgreSQLデータベースを起動
docker run --name woker-job-db \
  -e POSTGRES_DB=woker_job \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_PASSWORD=password \
  -p 5432:5432 \
  -d postgres:15

手動PostgreSQLインストール

  1. PostgreSQLをダウンロードしてインストール
  2. データベースを作成：
CREATE DATABASE woker_job;
CREATE USER woker_user WITH PASSWORD 'your_password';
GRANT ALL PRIVILEGES ON DATABASE woker_job TO woker_user;

5. データベースマイグレーションの実行

# バックエンドディレクトリに移動
cd apps/back-end

# マイグレーションを実行
pnpm run migration:run

6. 開発サーバーの起動

すべてのサービスを起動（推奨）

プロジェクトルートで：

pnpm run dev

サービスを個別に起動

バックエンドサービス：

cd apps/back-end
pnpm run start:dev

フロントエンドサービス：

cd apps/web
pnpm run dev

7. インストールの確認

  1. フロントエンドアプリケーションにアクセス：http://localhost:3000
  2. バックエンドAPIにアクセス：http://localhost:3001
  3. APIドキュメントを確認：http://localhost:3001/api

本番環境デプロイ

Dockerデプロイ

  1. イメージをビルド：
docker build -t woker-job .
  1. コンテナを実行：
docker run -d \
  --name woker-job \
  -p 3000:3000 \
  -p 3001:3001 \
  -e DATABASE_URL="your-production-db-url" \
  woker-job

手動デプロイ

  1. 本番バージョンをビルド：
pnpm run build
  1. 本番サービスを起動：
pnpm run start

よくある問題

ポート競合

ポート3000または3001が使用されている場合、環境変数を変更できます：

# フロントエンドポート
PORT=3002

# バックエンドポート
BACKEND_PORT=3003

データベース接続失敗

  1. データベースサービスが実行されているか確認
  2. 接続文字列の形式を確認
  3. ファイアウォール設定を確認

依存関係インストール失敗

  1. キャッシュをクリア：
pnpm store prune
npm cache clean --force
  1. node_modulesを削除して再インストール：
rm -rf node_modules
pnpm install

次のステップ

インストール後、以下を実行できます：

ヘルプを求める

インストール中に問題が発生した場合：

  1. トラブルシューティングガイドを確認
  2. GitHub Issuesを確認
  3. テクニカルサポートチームに連絡
Was this page helpful?
ようこそ紹介