未経験からのNestJS入門|環境構築

NestJS の環境構築する方法

Nest.js の環境を構築する方法は以下の二通りの方法があります。

  • Nest CLI を使用する方法
  • Git を利用してプロジェクトを直接ダウンロードする方法

おすすめは Nest CLI を使用する方法で、プロジェクト作成する以外に便利な CLI ツールを提供してくれます。

Nest CLI

Nest CLI を使用することで非常に簡単に環境構築することができます。

大まかなやり方は以下の通りです。

  1. Node.JS のインストール(インストールできていない方)
  2. Nest Cli をインストール
  3. Nest プロジェクトを作成
  4. Nest プロジェクトに移動し実行

npm をインストールしていない人は、公式サイトからNode.jsをインストールしてください。

npm を使用して Nest.js パッケージをインストールします。

npm i -g @nestjs/cli

インストールが完了したら Nest CLI が使用できるようになります。

次に以下コマンドを叩き、プロジェクトを構築してください。

nest new nest   ←  プロジェクト名

コマンドに成功したら、
npm か yarn のどちらかを使うように言われます。お好きなパッケージマネージャーを使用してください。

インストール完了したら。以下から nest プロジェクトが作成されます。

ここまで問題がなければ、アプリケーションを起動できます。
以下コマンドを作成されたディレクトリ配下で実行してください

cd nest
npm run start

Nest アプリケーションの実行が完了したら、プラウザアプリケーションからhttp://localhost:3000にアクセスしてみましょう。

Git からプロジェクトをダウンロードする方法

Nest CLI を使わずに Git からダウンロードし、即座に試すことも可能です。やり方は以下の通りです。

  1. 以下コマンドで Git Hub から Nest プロジェクトをダウンロード
  2. プロジェクト直下に移動
  3. 必要なパッケージがインストールされていないのでインストール
  4. npm run start で起動
git clone https://github.com/nestjs/typescript-starter.git project
cd project
npm install
npm run start

最後に

Nest.JS を構築する方法の紹介はこれで終わります。以上二つの方法でひな形アプリケーションの構築はできるかと思います。

後は公式ドキュメントを見るか、当サイトで各種機能を使い方を紹介しているのでそちら参照してください。

おまけ

今回は npm run start で本番用の実行方法で試してみましたが、
NestJS には、デフォルトでホットリロード機能がついている試験環境での実行も存在します。

方法は簡単で、以下のコードを実行するだけです。

npm run start:dev

以上です。お疲れ様です。