feat: add prisma

.env.example

@@ -1 +1,2 @@
 PORT=3000
+DATABASE_URL="file:./prisma/data.db"

.gitignore

@@ -66,3 +66,5 @@ dist
 
 # env
 .env
+
+*.db

README.md

@@ -8,6 +8,8 @@ Fastify starter template with Typescript, Prisma and Vitest
 
 ### Getting started
 
+#### 1. Download starter and install dependencies
+
 Run the following command on your local environment:
 
 ```shell
@@ -16,21 +18,34 @@ cd my-project-name
 bun install
 ```
 
-Set the environment variables:
+#### 2. Set the environment variables:
 
 ```shell
 cp .env.example .env
 
 # open .env and modify the environment variables (if needed)
 ```
 
-Then, you can run locally in development mode with live reload:
+#### 3. Create and seed the database
+
+Run the following command to create your SQLite database file. This also creates
+the `User` and `Post` tables that are defined in
+[`prisma/schema.prisma`](./prisma/schema.prisma):
+
+```shell
+bun prisma migrate dev --name init
+```
+
+#### 4. Start the Fastify server
+
+Launch your Fastify server in development mode with live reload:
 
 ```shell
 bun run dev
 ```
 
-Open http://localhost:3000 with your favorite browser to see your project.
+Navigate to [http://localhost:3000/](http://localhost:3000/) in your favorite
+browser to explore the API of your Fastify server.
 
 ### Commands
 
@@ -54,4 +69,5 @@ come with these default values:
 ```bash
 # Port number
 PORT=3000
+DATABASE_URL="./prisma/data.db"
 ```

package.json

@@ -14,13 +14,17 @@
     "build": "tsc",
     "dev": "ts-node-dev --log-error --files ./src/server.ts"
   },
+  "prisma": {
+    "seed": "ts-node prisma/seed.ts"
+  },
   "keywords": [],
   "author": "@pierreberger",
   "license": "ISC",
   "dependencies": {
     "@fastify/autoload": "^5.0.0",
     "@fastify/helmet": "^11.1.1",
     "@fastify/sensible": "^5.5.0",
+    "@prisma/client": "^5.8.1",
     "fastify": "^4.0.0",
     "fastify-cli": "^6.0.1",
     "fastify-plugin": "^4.0.0",
@@ -39,6 +43,7 @@
     "fastify-tsconfig": "^2.0.0",
     "pino-pretty": "^10.3.1",
     "prettier": "^3.2.4",
+    "prisma": "^5.8.1",
     "ts-node": "^10.4.0",
     "ts-node-dev": "^2.0.0",
     "typescript": "^5.2.2",

prisma/migrations/20240128200759_init/migration.sql

@@ -0,0 +1,20 @@
+-- CreateTable
+CREATE TABLE "User" (
+    "id" TEXT NOT NULL PRIMARY KEY,
+    "email" TEXT NOT NULL,
+    "name" TEXT
+);
+
+-- CreateTable
+CREATE TABLE "Post" (
+    "id" TEXT NOT NULL PRIMARY KEY,
+    "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" DATETIME NOT NULL,
+    "title" TEXT NOT NULL,
+    "content" TEXT,
+    "authorId" TEXT,
+    CONSTRAINT "Post_authorId_fkey" FOREIGN KEY ("authorId") REFERENCES "User" ("id") ON DELETE SET NULL ON UPDATE CASCADE
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "User_email_key" ON "User"("email");

prisma/migrations/migration_lock.toml

@@ -0,0 +1,3 @@
+# Please do not edit this file manually
+# It should be added in your version-control system (i.e. Git)
+provider = "sqlite"

prisma/schema.prisma

@@ -0,0 +1,25 @@
+generator client {
+    provider = "prisma-client-js"
+}
+
+datasource db {
+    provider = "sqlite"
+    url      = env("DATABASE_URL")
+}
+
+model User {
+    id    String  @id @default(cuid())
+    email String  @unique
+    name  String?
+    posts Post[]
+}
+
+model Post {
+    id        String   @id @default(cuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+    title     String
+    content   String?
+    author    User?    @relation(fields: [authorId], references: [id])
+    authorId  String?
+}

prisma/seed.ts

@@ -0,0 +1,61 @@
+import type { Prisma } from '@prisma/client'
+import { PrismaClient } from '@prisma/client'
+import { cleanupDb } from '../test/utils/db.util'
+
+const prisma = new PrismaClient()
+
+const users: Prisma.UserCreateInput[] = [
+  {
+    name: 'Pierre',
+    email: 'pierre@example.com',
+    posts: {
+      create: [
+        {
+          title: 'First Post',
+          content: 'This is an example post generated from `prisma/seed.ts`',
+        },
+      ],
+    },
+  },
+  {
+    name: 'John',
+    email: 'john@example.io',
+    posts: {
+      create: [
+        {
+          title: 'Second Post',
+          content:
+            'This is an other example post generated from `prisma/seed.ts`',
+        },
+      ],
+    },
+  },
+]
+
+async function seed() {
+  console.log('🌱 Seeding...')
+  console.time(`🌱 Database has been seeded`)
+
+  console.time('🧹 Cleaned up the database...')
+  await cleanupDb(prisma)
+  console.timeEnd('🧹 Cleaned up the database...')
+
+  console.time(`👤 Created ${users.length} users...`)
+  for (const user of users) {
+    await prisma.user.create({
+      data: user,
+    })
+  }
+  console.timeEnd(`👤 Created ${users.length} users...`)
+
+  console.timeEnd(`🌱 Database has been seeded`)
+}
+
+seed()
+  .catch(e => {
+    console.error(e)
+    process.exit(1)
+  })
+  .finally(async () => {
+    await prisma.$disconnect()
+  })

src/plugins/prisma.plugin.ts

@@ -0,0 +1,21 @@
+import { PrismaClient } from '@prisma/client'
+import type { FastifyPluginAsync } from 'fastify'
+import fp from 'fastify-plugin'
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    prisma: PrismaClient
+  }
+}
+
+export default fp<FastifyPluginAsync>(async (fastify, _opts) => {
+  const prisma = new PrismaClient()
+
+  await prisma.$connect()
+
+  fastify.decorate('prisma', prisma)
+
+  fastify.addHook('onClose', async fastify => {
+    await fastify.prisma.$disconnect()
+  })
+})

src/routes/users/users.route.ts

@@ -0,0 +1,9 @@
+import type { FastifyPluginAsync } from 'fastify'
+
+const users: FastifyPluginAsync = async (fastify, _opts) => {
+  fastify.get('/', async (_request, _reply) => {
+    return fastify.prisma.user.findMany()
+  })
+}
+
+export default users

test/utils/db.util.ts

@@ -0,0 +1,17 @@
+import type { PrismaClient } from '@prisma/client'
+
+export async function cleanupDb(prisma: PrismaClient) {
+  const tables = await prisma.$queryRaw<
+    { name: string }[]
+  >`SELECT name FROM sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%' AND name NOT LIKE '_prisma_migrations';`
+
+  await prisma.$transaction([
+    // Disable FK constraints to avoid relation conflicts during deletion
+    prisma.$executeRawUnsafe(`PRAGMA foreign_keys = OFF`),
+    // Delete all rows from each table, preserving table structures
+    ...tables.map(({ name }) =>
+      prisma.$executeRawUnsafe(`DELETE from "${name}"`),
+    ),
+    prisma.$executeRawUnsafe(`PRAGMA foreign_keys = ON`),
+  ])
+}