# Neon + NestJSでバックエンドを構築する手順

## 目次
1. はじめに
2. 開発環境のセットアップ
   1. Node.jsとNestJSのインストール
   2. Neonの導入
3. プロジェクトの初期化
   1. NestJSプロジェクトの作成
   2. 必須パッケージの追加
4. データベースの設定
   1. Neonの設定
   2. Prismaの導入と設定
5. APIの実装
   1. コントローラーとサービスの作成
   2. Prismaを使用したCRUD操作
6. 認証の追加
   1. JWTを使用した認証システム
   2. ガードとデコレータの設定
7. アプリのテストとデプロイ
   1. ユニットテストとE2Eテスト
   2. Dockerを使用したデプロイ
8. まとめ

## 1. はじめに

NeonはPostgreSQLをベースとした新しい分散型データベース技術で、高い信頼性とスケーラビリティを提供することを目指しています。NestJSはNode.jsのフレームワークの中でも非常にモダンで、堅牢かつ拡張性の高いバックエンド開発を可能にします。この記事では、NeonとNestJSを併用してバックエンドを構築する手順を詳しく見ていきます。

## 2. 開発環境のセットアップ

### 2-1. Node.jsとNestJSのインストール

Node.jsを公式サイトからダウンロードしてインストールしてください。最新のLTSバージョンを推奨します。

![img](/mosaic-code.jpg)

その後、Nest CLIをインストールします:

![img](/mosaic-code.jpg)

### 2-2. Neonの導入

Neonの利用には、まずアカウントを作成し、クラウド環境を設定する必要があります。公式サイトから簡単にサインアップできます。

## 3. プロジェクトの初期化

### 3-1. NestJSプロジェクトの作成

次に、NestJSプロジェクトを新規作成します。

![img](/mosaic-code.jpg)

### 3-2. 必須パッケージの追加

Prismaを使用してNeonとNestJSを接続するために、以下のパッケージを追加します。

![img](/mosaic-code.jpg)

## 4. データベースの設定

### 4-1. Neonの設定

Neonダッシュボードで新しいデータベースを作成し、その接続文字列をコピーします。`DATABASE_URL`として環境変数に設定してください。

### 4-2. Prismaの導入と設定

`prisma/schema.prisma`ファイルを編集します。以下に例を示します。

![img](/mosaic-code.jpg)

スキーマを設定したら、以下のコマンドでデータベースをマイグレーションします。

![img](/mosaic-code.jpg)

## 5. APIの実装

### 5-1. コントローラーとサービスの作成

NestJS CLIを使用して`User`のモジュール、サービス、コントローラーを生成します。

![img](/mosaic-code.jpg)

### 5-2. Prismaを使用したCRUD操作

`UserService`内でPrisma Clientを使用してCRUD（作成、読み取り、更新、削除）操作を実装します。

例:

![img](/mosaic-code.jpg)

## 6. 認証の追加

### 6-1. JWTを使用した認証システム

JWT（JSON Web Token）を用いて認証機能を追加します。まず、必要なパッケージをインストールします。

![img](/mosaic-code.jpg)

### 6-2. ガードとデコレータの設定

AuthServiceを作成し、JWTを使用したトークン発行と検証を実装します。ガードとデコレータを設定して、特定のエンドポイントに認証を要求するようにします。

## 7. アプリのテストとデプロイ

### 7-1. ユニットテストとE2Eテスト

Jestを用いたユニットテストとE2E（End-to-End）テストを設定します。テストスクリプトを`package.json`に追加し、適宜テストを実施します。

![img](/mosaic-code.jpg)

### 7-2. Dockerを使用したデプロイ

最終段階として、Dockerを使用してアプリケーションをコンテナ化し、簡単にデプロイできるようにします。以下に基本的なDockerfileの例を示します。

![img](/mosaic-code.jpg)

## 8. まとめ

NeonとNestJSを組み合わせることで、信頼性の高い、スケーラブルなバックエンドを構築することができます。NestJSの強力なモジュールシステムと、Neonによる柔軟かつ強力なデータベース管理を活用することで、迅速に開発を進めることが可能です。次回はより高度な機能、例えばGraphQLの導入やマイクロサービスアーキテクチャの実現についても掘り下げて行きたいと思います。 [cv:issue_marketplace_engineer]

# Neon + NestJSでバックエンドを構築する手順

## 目次
1. はじめに
2. 開発環境のセットアップ
   1. Node.jsとNestJSのインストール
   2. Neonの導入
3. プロジェクトの初期化
   1. NestJSプロジェクトの作成
   2. 必須パッケージの追加
4. データベースの設定
   1. Neonの設定
   2. Prismaの導入と設定
5. APIの実装
   1. コントローラーとサービスの作成
   2. Prismaを使用したCRUD操作
6. 認証の追加
   1. JWTを使用した認証システム
   2. ガードとデコレータの設定
7. アプリのテストとデプロイ
   1. ユニットテストとE2Eテスト
   2. Dockerを使用したデプロイ
8. まとめ

## 1. はじめに

NeonはPostgreSQLをベースとした新しい分散型データベース技術で、高い信頼性とスケーラビリティを提供することを目指しています。NestJSはNode.jsのフレームワークの中でも非常にモダンで、堅牢かつ拡張性の高いバックエンド開発を可能にします。この記事では、NeonとNestJSを併用してバックエンドを構築する手順を詳しく見ていきます。

## 2. 開発環境のセットアップ

### 2-1. Node.jsとNestJSのインストール

Node.jsを公式サイトからダウンロードしてインストールしてください。最新のLTSバージョンを推奨します。

```bash
$ node -v
v16.15.0
```

その後、Nest CLIをインストールします:

```bash
npm install -g @nestjs/cli
```

### 2-2. Neonの導入

Neonの利用には、まずアカウントを作成し、クラウド環境を設定する必要があります。公式サイトから簡単にサインアップできます。

## 3. プロジェクトの初期化

### 3-1. NestJSプロジェクトの作成

次に、NestJSプロジェクトを新規作成します。

```bash
nest new my-neon-project
cd my-neon-project
```

### 3-2. 必須パッケージの追加

Prismaを使用してNeonとNestJSを接続するために、以下のパッケージを追加します。

```bash
npm install prisma @prisma/client
npx prisma init
```

## 4. データベースの設定

### 4-1. Neonの設定

Neonダッシュボードで新しいデータベースを作成し、その接続文字列をコピーします。`DATABASE_URL`として環境変数に設定してください。

### 4-2. Prismaの導入と設定

`prisma/schema.prisma`ファイルを編集します。以下に例を示します。

```prisma
datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

model User {
  id    Int     @id @default(autoincrement())
  name  String
  email String  @unique
}
```

スキーマを設定したら、以下のコマンドでデータベースをマイグレーションします。

```bash
npx prisma migrate dev --name init
```

## 5. APIの実装

### 5-1. コントローラーとサービスの作成

NestJS CLIを使用して`User`のモジュール、サービス、コントローラーを生成します。

```bash
nest generate module user
nest generate service user
nest generate controller user
```

### 5-2. Prismaを使用したCRUD操作

`UserService`内でPrisma Clientを使用してCRUD（作成、読み取り、更新、削除）操作を実装します。

例:

```typescript
import { PrismaService } from './prisma.service';

@Injectable()
export class UserService {
  constructor(private prisma: PrismaService) {}

  async findAll(): Promise<User[]> {
    return this.prisma.user.findMany();
  }
  
  // 他のCRUD操作もここに実装
}
```

## 6. 認証の追加

### 6-1. JWTを使用した認証システム

JWT（JSON Web Token）を用いて認証機能を追加します。まず、必要なパッケージをインストールします。

```bash
npm install @nestjs/jwt @nestjs/passport passport passport-jwt
```

### 6-2. ガードとデコレータの設定

AuthServiceを作成し、JWTを使用したトークン発行と検証を実装します。ガードとデコレータを設定して、特定のエンドポイントに認証を要求するようにします。

## 7. アプリのテストとデプロイ

### 7-1. ユニットテストとE2Eテスト

Jestを用いたユニットテストとE2E（End-to-End）テストを設定します。テストスクリプトを`package.json`に追加し、適宜テストを実施します。

```json
"scripts": {
  "test": "jest",
  "test:e2e": "jest --config ./test/jest-e2e.json"
}
```

### 7-2. Dockerを使用したデプロイ

最終段階として、Dockerを使用してアプリケーションをコンテナ化し、簡単にデプロイできるようにします。以下に基本的なDockerfileの例を示します。

```dockerfile
FROM node:16

WORKDIR /app

COPY package.json ./
RUN npm install

COPY . .

RUN npm run build

CMD ["node", "dist/main"]
```

## 8. まとめ

NeonとNestJSを組み合わせることで、信頼性の高い、スケーラブルなバックエンドを構築することができます。NestJSの強力なモジュールシステムと、Neonによる柔軟かつ強力なデータベース管理を活用することで、迅速に開発を進めることが可能です。次回はより高度な機能、例えばGraphQLの導入やマイクロサービスアーキテクチャの実現についても掘り下げて行きたいと思います。 [![image](https://firebasestorage.googleapis.com/v0/b/issue-pro-42602.appspot.com/o/topics%2F17fa658b-53c7-4ca0-a28b-e588ed1bd371?alt=media&token=2c00afff-85ff-4428-8d15-696ab676dcb0)](https://i-ssue.com/lp/check_salary)

Neon + NestJSでバックエンドを構築する手順

目次

続きを読むには単価診断を受けてください（30秒）