メインコンテンツまでスキップ

2. SetUp

開発環境のセットアップ​

Nest.js開発を始めるためには、適切な開発環境をセットアップすることが重要です。以下の手順に従って、必要なツールと設定を整えましょう。

Node.jsとnpm​

まず、Node.jsとnpm（Node Package Manager）をインストールします。Node.jsはサーバーサイドのJavaScriptランタイムであり、npmはJavaScriptパッケージの管理ツールです。これらはNest.jsアプリケーションの開発に欠かせません。

  1. Node.jsの公式サイトから、最新のLTS（Long Term Support）バージョンをダウンロードしてインストールします。

  2. インストール後、コマンドラインで以下のコマンドを実行して、Node.jsとnpmが正しくインストールされたことを確認します：

    node -v
    npm -v

コードエディタ​

Nest.js開発には、効率的にコードを書くためのコードエディタが必要です。以下のエディタは、Nest.js開発において人気があります：

  • Visual Studio Code（VS Code）

  • WebStorm

    • JetBrainsが提供する有料のIDEで、豊富な機能と高いカスタマイズ性を持っています。
    • ダウンロードリンク

Gitによるバージョン管理​

プロジェクトのバージョン管理にはGitを使用します。Gitは、ソースコードの変更履歴を管理するための分散型バージョン管理システムです。

  1. Gitの公式サイトからGitをダウンロードしてインストールします。

  2. インストール後、コマンドラインで以下のコマンドを実行して、Gitが正しくインストールされたことを確認します：

    git --version

Nest.jsのインストール​

Nest CLI（Command Line Interface）は、Nest.jsアプリケーションを迅速にセットアップし、プロジェクトを管理するためのツールです。以下のコマンドを実行してNest CLIをグローバルにインストールします：

npm install -g @nestjs/cli

プロジェクトの初期設定​

Nest CLIを使用して新しいプロジェクトを作成します：

nest new project-name

コマンドを実行すると、プロジェクト名を指定するよう求められます。その後、Nest CLIはプロジェクトのテンプレートを生成し、必要な依存関係をインストールします。

ディレクトリ構造の説明​

作成されたプロジェクトのディレクトリ構造は以下のようになっています：

src/
├── app.controller.ts
├── app.module.ts
├── app.service.ts
└── main.ts
  • app.controller.ts：基本的なコントローラーの実装が含まれています。
  • app.module.ts：アプリケーションのメインモジュールを定義しています。
  • app.service.ts：基本的なサービスの実装が含まれています。
  • main.ts：アプリケーションのエントリーポイントです。

プロジェクトの実行​

以下のコマンドを実行して、Nest.jsアプリケーションを起動します：

npm run start

ブラウザで http://localhost:3000 にアクセスして、Nest.jsアプリケーションが正しく動作していることを確認します。

プロジェクトのディレクトリ構造​

Nest.jsプロジェクトのディレクトリ構造は、モジュールベースで設計されており、コードの管理と再利用が容易です。以下は、一般的なNest.jsプロジェクトのディレクトリ構造の例です：

my-app/
├── src/
│   ├── modules/
│   │   ├── cats/
│   │   │   ├── cats.controller.ts
│   │   │   ├── cats.module.ts
│   │   │   └── cats.service.ts
│   ├── main.ts
│   └── app.module.ts
├── test/
│   ├── app.e2e-spec.ts
│   └── jest-e2e.json
├── .eslintrc.js
├── .prettierrc
├── nest-cli.json
├── package.json
├── README.md
└── tsconfig.json
  • modules/：アプリケーションの各機能モジュールを配置します。
  • main.ts：アプリケーションのエントリーポイント。
  • test/：テストコードを配置します。
  • .eslintrc.js：ESLintの設定ファイル。
  • .prettierrc：Prettierの設定ファイル。
  • nest-cli.json：Nest CLIの設定ファイル。
  • tsconfig.json：TypeScriptの設定ファイル。

この構造を基に、プロジェクトの規模や要件に応じてカスタマイズしてください。