environment-setup-guide

環境セットアップガイド

概要

開発者が完全な開発環境をゼロからセットアップできるように支援します。このスキルは、ツールのインストール、依存関係の設定、環境変数のセットアップ、セットアップが正しく動作することの確認について、ステップバイステップのガイダンスを提供します。

このスキルを使用する場面

• 新しいプロジェクトを開始し、開発環境をセットアップする必要がある場合
• 新しいチームメンバーをプロジェクトにオンボーディングする場合
• 新しいマシンやオペレーティングシステムに切り替える場合
• 環境関連の問題をトラブルシューティングする場合
• プロジェクトのセットアップ手順を文書化する場合
• 開発環境のドキュメントを作成する場合

仕組み

ステップ 1: 要件の特定

インストールが必要なものを判断するお手伝いをします:

• プログラミング言語とバージョン (Node.js、Python、Go など)
• パッケージマネージャー (npm、pip、cargo など)
• データベースシステム (PostgreSQL、MongoDB、Redis など)
• 開発ツール (Git、Docker、IDE 拡張機能など)
• 環境変数と設定ファイル

ステップ 2: 現在のセットアップの確認

何かをインストールする前に、すでにインストールされているものを確認するお手伝いをします:

# Check versions of installed tools
node --version
python --version
git --version
docker --version

ステップ 3: インストール手順の提供

プラットフォーム固有のインストールコマンドを提供します:

• macOS: Homebrew を使用
• Linux: apt、yum、またはパッケージマネージャーを使用
• Windows: Chocolatey、Scoop、または直接インストーラーを使用

ステップ 4: 環境の設定

以下をセットアップするお手伝いをします:

• 環境変数 (.env ファイル)
• 設定ファイル (.gitconfig、.npmrc など)
• IDE 設定 (VS Code、IntelliJ など)
• シェル設定 (.bashrc、.zshrc など)

ステップ 5: インストールの確認

すべてが動作することを確認するための検証手順を提供します:

• バージョンチェックの実行
• 基本コマンドのテスト
• データベース接続の確認
• 環境変数が読み込まれていることの確認

例

例 1: Node.js プロジェクトのセットアップ

## Setting Up Node.js Development Environment

### Prerequisites
- macOS, Linux, or Windows
- Terminal/Command Prompt access
- Internet connection

### Step 1: Install Node.js

**macOS (using Homebrew):**
\`\`\`bash
# Install Homebrew if not installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install Node.js
brew install node
\`\`\`

**Linux (Ubuntu/Debian):**
\`\`\`bash
# Update package list
sudo apt update

# Install Node.js and npm
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs
\`\`\`

**Windows (using Chocolatey):**
\`\`\`powershell
# Install Chocolatey if not installed
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

# Install Node.js
choco install nodejs
\`\`\`

### Step 2: Verify Installation

\`\`\`bash
node --version  # Should show v20.x.x or higher
npm --version   # Should show 10.x.x or higher
\`\`\`

### Step 3: Install Project Dependencies

\`\`\`bash
# Clone the repository
git clone https://github.com/your-repo/project.git
cd project

# Install dependencies
npm install
\`\`\`

### Step 4: Set Up Environment Variables

Create a \`.env\` file:
\`\`\`bash
# Copy example environment file
cp .env.example .env

# Edit with your values
nano .env
\`\`\`

Example \`.env\` content:
\`\`\`
NODE_ENV=development
PORT=3000
DATABASE_URL=postgresql://localhost:5432/mydb
API_KEY=your-api-key-here
\`\`\`

### Step 5: Run the Project

\`\`\`bash
# Start development server
npm run dev

# Should see: Server running on http://localhost:3000
\`\`\`

### Troubleshooting

**Problem:** "node: command not found"
**Solution:** Restart your terminal or run \`source ~/.bashrc\` (Linux) or \`source ~/.zshrc\` (macOS)

**Problem:** "Permission denied" errors
**Solution:** Don't use sudo with npm. Fix permissions:
\`\`\`bash
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
\`\`\`

例 2: Python プロジェクトのセットアップ

## Setting Up Python Development Environment

### Step 1: Install Python

**macOS:**
\`\`\`bash
brew install [email protected]
\`\`\`

**Linux:**
\`\`\`bash
sudo apt update
sudo apt install python3.11 python3.11-venv python3-pip
\`\`\`

**Windows:**
\`\`\`powershell
choco install python --version=3.11
\`\`\`

### Step 2: Verify Installation

\`\`\`bash
python3 --version  # Should show Python 3.11.x
pip3 --version     # Should show pip 23.x.x
\`\`\`

### Step 3: Create Virtual Environment

\`\`\`bash
# Navigate to project directory
cd my-project

# Create virtual environment
python3 -m venv venv

# Activate virtual environment
# macOS/Linux:
source venv/bin/activate

# Windows:
venv\Scripts\activate
\`\`\`

### Step 4: Install Dependencies

\`\`\`bash
# Install from requirements.txt
pip install -r requirements.txt

# Or install packages individually
pip install flask sqlalchemy python-dotenv
\`\`\`

### Step 5: Set Up Environment Variables

Create \`.env\` file:
\`\`\`
FLASK_APP=app.py
FLASK_ENV=development
DATABASE_URL=sqlite:///app.db
SECRET_KEY=your-secret-key-here
\`\`\`

### Step 6: Run the Application

\`\`\`bash
# Run Flask app
flask run

# Should see: Running on http://127.0.0.1:5000
\`\`\`

例 3: Docker 開発環境

## Setting Up Docker Development Environment

### Step 1: Install Docker

**macOS:**
\`\`\`bash
brew install --cask docker
# Or download Docker Desktop from docker.com
\`\`\`

**Linux:**
\`\`\`bash
# Install Docker
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

# Add user to docker group
sudo usermod -aG docker $USER
newgrp docker
\`\`\`

**Windows:**
Download Docker Desktop from docker.com

### Step 2: Verify Installation

\`\`\`bash
docker --version        # Should show Docker version 24.x.x
docker-compose --version # Should show Docker Compose version 2.x.x
\`\`\`

### Step 3: Create docker-compose.yml

\`\`\`yaml
version: '3.8'

services:
  app:
    build: .
    ports:
      - "3000:3000"
    environment:
      - NODE_ENV=development
      - DATABASE_URL=postgresql://postgres:password@db:5432/mydb
    volumes:
      - .:/app
      - /app/node_modules
    depends_on:
      - db

  db:
    image: postgres:15
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=mydb
    ports:
      - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data

volumes:
  postgres_data:
\`\`\`

### Step 4: Start Services

\`\`\`bash
# Build and start containers
docker-compose up -d

# View logs
docker-compose logs -f

# Stop services
docker-compose down
\`\`\`

### Step 5: Verify Services

\`\`\`bash
# Check running containers
docker ps

# Test database connection
docker-compose exec db psql -U postgres -d mydb
\`\`\`

ベストプラクティス

✅ 推奨すること

• すべてを文書化する - 明確なセットアップ手順を書く
• バージョンマネージャーを使用する - Node には nvm、Python には pyenv
• .env.example を作成する - 必要な環境変数を示す
• クリーンなシステムでテストする - 手順がゼロから動作することを確認する
• トラブルシューティングを含める - 一般的な問題と解決策を文書化する
• Docker を使用する - マシン間で一貫した環境を実現する
• バージョンを固定する - パッケージファイルで正確なバージョンを指定する
• セットアップを自動化する - 可能な場合はセットアップスクリプトを作成する
• 前提条件を確認する - 開始前に必要なツールをリストアップする
• 検証手順を提供する - ユーザーがセットアップの動作を確認できるようにする

❌ 避けるべきこと

• ツールがインストールされていると仮定しない - 常に確認し、インストール手順を提供する
• 環境変数を省略しない - 必要なすべての変数を文書化する
• npm で sudo を使用しない - 代わりにパーミッションを修正する
• プラットフォームの違いを忘れない - OS 固有の手順を提供する
• 検証を省略しない - 常にテスト手順を含める
• グローバルインストールを使用しない - ローカル/仮想環境を優先する
• エラーを無視しない - 一般的なエラーの対処方法を文書化する
• データベースのセットアップを省略しない - データベースの初期化手順を含める

よくある落とし穴

問題: インストール後に「command not found」が発生する

症状: ツールをインストールしたが、ターミナルがそれを認識しない 解決策:

• ターミナルを再起動するか、シェル設定を再読み込みする
• PATH 環境変数を確認する
• インストール場所を確認する

# Check PATH
echo $PATH

# Add to PATH (example)
export PATH="/usr/local/bin:$PATH"

問題: npm/pip でのパーミッションエラー

症状: 「EACCES」または「Permission denied」エラーが発生する 解決策:

• sudo を使用しない
• npm のパーミッションを修正するか、nvm を使用する
• Python には仮想環境を使用する

# Fix npm permissions
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc

問題: ポートがすでに使用されている

症状: 「Port 3000 is already in use」が発生する 解決策:

• そのポートを使用しているプロセスを見つけて終了する
• 別のポートを使用する

# Find process on port 3000
lsof -i :3000

# Kill process
kill -9 <PID>

# Or use different port
PORT=3001 npm start

問題: データベース接続に失敗する

症状: "Connection refused" または "Authentication failed" 解決策:

• データベースが起動しているか確認する
• 接続文字列を確認する
• 認証情報を確認する

# Check if PostgreSQL is running
sudo systemctl status postgresql

# Test connection
psql -h localhost -U postgres -d mydb

セットアップスクリプトのテンプレート

setup.sh スクリプトを作成して、セットアップを自動化します:

#!/bin/bash

echo "🚀 Setting up development environment..."

# Check prerequisites
command -v node >/dev/null 2>&1 || { echo "❌ Node.js not installed"; exit 1; }
command -v git >/dev/null 2>&1 || { echo "❌ Git not installed"; exit 1; }

echo "✅ Prerequisites check passed"

# Install dependencies
echo "📦 Installing dependencies..."
npm install

# Copy environment file
if [ ! -f .env ]; then
    echo "📝 Creating .env file..."
    cp .env.example .env
    echo "⚠️  Please edit .env with your configuration"
fi

# Run database migrations
echo "🗄️  Running database migrations..."
npm run migrate

# Verify setup
echo "🔍 Verifying setup..."
npm run test:setup

echo "✅ Setup complete! Run 'npm run dev' to start"

関連スキル

• @brainstorming - セットアップ前に環境要件を計画する
• @systematic-debugging - 環境の問題をデバッグする
• @doc-coauthoring - セットアップドキュメントを作成する
• @git-pushing - Git の設定を行う

追加リソース

• Node.js インストールガイド
• Python Virtual Environments
• Docker ドキュメント
• Homebrew (macOS)
• Chocolatey (Windows)
• nvm (Node Version Manager)
• pyenv (Python Version Manager)

---

Pro Tip: setup.sh または setup.ps1 スクリプトを作成して、セットアップ全体のプロセスを自動化しましょう。クリーンなシステムでテストして、動作することを確認してください。