【Nest.js入門】プロジェクト作成

2022 8/28

2022年8月28日 2022年8月28日

環境構築

Nest CLIをインストールする

まずはNest.jsをインストールします

$ npm i -g @nestjs/cli


added 255 packages, and audited 256 packages in 20s

39 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

インストールができたか確認します

$ which nest
/Users/hogehoge(macにログインしている名前)/.npm-global/bin/nestが返却される

プロジェクトを新規作成

$ nest new project-name

使用するパッケージ管理ツールを聞かれるので選択する。（今回はyarnを選択）

? Which package manager would you ❤️  to use?
  npm
❯ yarn
  pnpm

すると下記のように表示が出ます

成功すると下記の画像のような表示が出ます

もしもエラーが出た場合は、この記事の先に進むとエラーの対処方法を記載しているので、そちらをご確認ください

指示された通りに、ディレクトリに移行して、yarn startを実行します

$ cd project-name
$ yarn start


yarn run v1.22.11
$ nest start
[Nest] 2544  - 2022/08/28 12:40:43     LOG [NestFactory] Starting Nest application...
[Nest] 2544  - 2022/08/28 12:40:43     LOG [InstanceLoader] AppModule dependencies initialized +95ms
[Nest] 2544  - 2022/08/28 12:40:43     LOG [RoutesResolver] AppController {/}: +5ms
[Nest] 2544  - 2022/08/28 12:40:43     LOG [RouterExplorer] Mapped {/, GET} route +2ms
[Nest] 2544  - 2022/08/28 12:40:43     LOG [NestApplication] Nest application successfully started +2ms

nest.jsが起動できたので、http://localhost:3000/にアクセスします

すると、Hellow Worldが表示されます

これでプロジェクトの作成は以上となります

エラーが出た場合

下記のようなエラーが表示されるケースがあります。

? Which package manager would you ❤️  to use? yarn
▹▹▹▸▹ Installation in progress... ☕
Failed to execute command: yarn install --silent
✖ Installation in progress... ☕
🙀  Packages installation failed!
In case you don't see any errors above, consider manually running the failed command yarn install to see more details on why it errored out.

このエラーを確認するとyarn install --silentで失敗していることがわかります。

そこで、ディレクトリを移行して、直接yarn installを実行して、エラーの詳細を確認します。

cd project-name
$ yarn install --silent

error @typescript-eslint/eslint-plugin@5.35.1: The engine "node" is incompatible with this module. Expected version "^12.22.0 || ^14.17.0 || >=16.0.0". Got "14.16.0"
error Found incompatible module.

エラーの内容を確認すると、現在のnodeのバージョンと互換性がないようです。

//エンジン "node "はこのモジュールと互換性がありません
The engine "node" is incompatible with this module.

// 期待されるバージョン "^12.22.0 || ^14.17.0 || >=16.0.0". 14.16.0 "を取得 
Expected version "^12.22.0 || ^14.17.0 || >=16.0.0". Got "14.16.0"

そこで、node.jsのバージョンを更新します

更新方法は下記の記事を参考にしてください。