Seed files

What is a seed file? 🌱

Quite often in development, we want to quickly generate some data for our database. For example, we might want to add some test users, or some categories for our articles.

A seed file is the perfect way to do this.

In Prisma, the seed file is located in prisma/seed.ts. Open this now in your code editor.

Adding categories.

Inside prisma/seed.js file, add the following code at around line 252. Look carefully at the code around it to understand where it should go:

prisma/seed.ts

import { faker } from '@faker-js/faker'
import { prisma } from '#app/utils/db.server.ts'
import { MOCK_CODE_GITHUB } from '#app/utils/providers/constants'
import {
  cleanupDb,
  createPassword,
  createUser,
  getArticleImages,
  getUserImages,
} from '#tests/db-utils.ts'
import { insertGitHubUser } from '#tests/mocks/github.ts'

async function seed() {
  console.log('🌱 Seeding...')
  console.time(`🌱 Database has been seeded`)

  console.log('🧹 Cleaning up existing data...')
  console.time('🧹 Database cleanup completed')
  await cleanupDb()
  console.timeEnd('🧹 Database cleanup completed')

  const totalUsers = 5
  console.time(`👤 Created ${totalUsers} users...`)
  const articleImages = await getArticleImages()
  const userImages = await getUserImages()

  for (let index = 0; index < totalUsers; index++) {
    const userData = createUser()
    const user = await prisma.user.create({
      select: { id: true },
      data: {
        ...userData,
        password: { create: createPassword(userData.username) },
        roles: { connect: { name: 'user' } },
      },
    })

    // Upload user profile image
    const userImage = userImages[index % userImages.length]
    if (userImage) {
      await prisma.userImage.create({
        data: {
          userId: user.id,
          objectKey: userImage.objectKey,
        },
      })
    }

    // Create articles with images
    const articlesCount = faker.number.int({ min: 1, max: 3 })
    for (let articleIndex = 0; articleIndex < articlesCount; articleIndex++) {
      const article = await prisma.article.create({
        select: { id: true },
        data: {
          title: faker.lorem.sentence(),
          content: faker.lorem.paragraphs(),
          ownerId: user.id,
        },
      })

      // Add images to article
      const articleImageCount = faker.number.int({ min: 1, max: 3 })
      for (let imageIndex = 0; imageIndex < articleImageCount; imageIndex++) {
        const imgNumber = faker.number.int({ min: 0, max: 9 })
        const articleImage = articleImages[imgNumber]
        if (articleImage) {
          await prisma.articleImage.create({
            data: {
              articleId: article.id,
              altText: articleImage.altText,
              objectKey: articleImage.objectKey,
            },
          })
        }
      }
    }
  }
  console.timeEnd(`👤 Created ${totalUsers} users...`)

  console.time(`🐨 Created admin user "kody"`)

  const kodyImages = {
    kodyUser: { objectKey: 'user/kody.png' },
    cuteKoala: {
      altText: 'an adorable koala cartoon illustration',
      objectKey: 'kody-articles/cute-koala.png',
    },
    koalaEating: {
      altText: 'a cartoon illustration of a koala in a tree eating',
      objectKey: 'kody-articles/koala-eating.png',
    },
    koalaCuddle: {
      altText: 'a cartoon illustration of koalas cuddling',
      objectKey: 'kody-articles/koala-cuddle.png',
    },
    mountain: {
      altText: 'a beautiful mountain covered in snow',
      objectKey: 'kody-articles/mountain.png',
    },
    koalaCoder: {
      altText: 'a koala coding at the computer',
      objectKey: 'kody-articles/koala-coder.png',
    },
    koalaMentor: {
      altText:
        'a koala in a friendly and helpful posture. The Koala is standing next to and teaching a woman who is coding on a computer and shows positive signs of learning and understanding what is being explained.',
      objectKey: 'kody-articles/koala-mentor.png',
    },
    koalaSoccer: {
      altText: 'a cute cartoon koala kicking a soccer ball on a soccer field ',
      objectKey: 'kody-articles/koala-soccer.png',
    },
  }

  const githubUser = await insertGitHubUser(MOCK_CODE_GITHUB)

  const kody = await prisma.user.create({
    select: { id: true },
    data: {
      email: 'kody@kcd.dev',
      username: 'kody',
      name: 'Kody',
      password: { create: createPassword('kodylovesyou') },
      connections: {
        create: {
          providerName: 'github',
          providerId: String(githubUser.profile.id),
        },
      },
      roles: { connect: [{ name: 'admin' }, { name: 'user' }] },
    },
  })

  await prisma.userImage.create({
    data: {
      userId: kody.id,
      objectKey: kodyImages.kodyUser.objectKey,
    },
  })

  // Create Kody's articles
  const kodyArticles = [
    {
      id: 'd27a197e',
      title: 'Basic Koala Facts',
      content:
        'Koalas are found in the eucalyptus forests of eastern Australia. They have grey fur with a cream-coloured chest, and strong, clawed feet, perfect for living in the branches of trees!',
      images: [kodyImages.cuteKoala, kodyImages.koalaEating],
    },
    {
      id: '414f0c09',
      title: 'Koalas like to cuddle',
      content:
        'Cuddly critters, koalas measure about 60cm to 85cm long, and weigh about 14kg.',
      images: [kodyImages.koalaCuddle],
    },
    {
      id: '260366b1',
      title: 'Not bears',
      content:
        "Although you may have heard people call them koala 'bears', these awesome animals aren't bears at all – they are in fact marsupials. A group of mammals, most marsupials have pouches where their newborns develop.",
      images: [],
    },
    {
      id: 'bb79cf45',
      title: 'Snowboarding Adventure',
      content:
        "Today was an epic day on the slopes! Shredded fresh powder with my friends, caught some sick air, and even attempted a backflip. Can't wait for the next snowy adventure!",
      images: [kodyImages.mountain],
    },
    {
      id: '9f4308be',
      title: 'Onewheel Tricks',
      content:
        "Mastered a new trick on my Onewheel today called '180 Spin'. It's exhilarating to carve through the streets while pulling off these rad moves. Time to level up and learn more!",
      images: [],
    },
    {
      id: '306021fb',
      title: 'Coding Dilemma',
      content:
        "Stuck on a bug in my latest coding project. Need to figure out why my function isn't returning the expected output. Time to dig deep, debug, and conquer this challenge!",
      images: [kodyImages.koalaCoder],
    },
    {
      id: '16d4912a',
      title: 'Coding Mentorship',
      content:
        "Had a fantastic coding mentoring session today with Sarah. Helped her understand the concept of recursion, and she made great progress. It's incredibly fulfilling to help others improve their coding skills.",
      images: [kodyImages.koalaMentor],
    },
    {
      id: '3199199e',
      title: 'Koala Fun Facts',
      content:
        "Did you know that koalas sleep for up to 20 hours a day? It's because their diet of eucalyptus leaves doesn't provide much energy. But when I'm awake, I enjoy munching on leaves, chilling in trees, and being the cuddliest koala around!",
      images: [],
    },
    {
      id: '2030ffd3',
      title: 'Skiing Adventure',
      content:
        'Spent the day hitting the slopes on my skis. The fresh powder made for some incredible runs and breathtaking views. Skiing down the mountain at top speed is an adrenaline rush like no other!',
      images: [kodyImages.mountain],
    },
    {
      id: 'f375a804',
      title: 'Code Jam Success',
      content:
        'Participated in a coding competition today and secured the first place! The adrenaline, the challenging problems, and the satisfaction of finding optimal solutions—it was an amazing experience. Feeling proud and motivated to keep pushing my coding skills further!',
      images: [kodyImages.koalaCoder],
    },
    {
      id: '562c541b',
      title: 'Koala Conservation Efforts',
      content:
        "Joined a local conservation group to protect koalas and their habitats. Together, we're planting more eucalyptus trees, raising awareness about their endangered status, and working towards a sustainable future for these adorable creatures. Every small step counts!",
      images: [],
    },
    {
      id: 'f67ca40b',
      title: 'Game day',
      content:
        "Just got back from the most amazing game. I've been playing soccer for a long time, but I've not once scored a goal. Well, today all that changed! I finally scored my first ever goal.\n\nI'm in an indoor league, and my team's not the best, but we're pretty good and I have fun, that's all that really matters. Anyway, I found myself at the other end of the field with the ball. It was just me and the goalie. I normally just kick the ball and hope it goes in, but the ball was already rolling toward the goal. The goalie was about to get the ball, so I had to charge. I managed to get possession of the ball just before the goalie got it. I brought it around the goalie and had a perfect shot. I screamed so loud in excitement. After all these years playing, I finally scored a goal!\n\nI know it's not a lot for most folks, but it meant a lot to me. We did end up winning the game by one. It makes me feel great that I had a part to play in that.\n\nIn this team, I'm the captain. I'm constantly cheering my team on. Even after getting injured, I continued to come and watch from the side-lines. I enjoy yelling (encouragingly) at my team mates and helping them be the best they can. I'm definitely not the best player by a long stretch. But I really enjoy the game. It's a great way to get exercise and have good social interactions once a week.\n\nThat said, it can be hard to keep people coming and paying dues and stuff. If people don't show up it can be really hard to find subs. I have a list of people I can text, but sometimes I can't find anyone.\n\nBut yeah, today was awesome. I felt like more than just a player that gets in the way of the opposition, but an actual asset to the team. Really great feeling.\n\nAnyway, I'm rambling at this point and really this is just so we can have a article that's pretty long to test things out. I think it's long enough now... Cheers!",
      images: [kodyImages.koalaSoccer],
    },
  ]

  for (const articleData of kodyArticles) {
    const article = await prisma.article.create({
      select: { id: true },
      data: {
        id: articleData.id,
        title: articleData.title,
        content: articleData.content,
        ownerId: kody.id,
      },
    })

    for (const image of articleData.images) {
      await prisma.articleImage.create({
        data: {
          articleId: article.id,
          altText: image.altText,
          objectKey: image.objectKey,
        },
      })
    }
  }

  console.timeEnd(`🐨 Created admin user "kody"`)

  // Create article categories
  console.time(`🗃️  Created article categories...`)
  const articleCategories = [
    { name: 'Technology', slug: 'technology' },
    { name: 'Entertainment', slug: 'entertainment' },
    { name: 'Business', slug: 'business' },
  ]
  await prisma.articleCategory.createMany({ data: articleCategories })
  console.timeEnd(`🗃️  Created article categories...`)

  console.timeEnd(`🌱 Database has been seeded`)
}

seed()
  .catch((e) => {
    console.error(e)
    process.exit(1)
  })
  .finally(async () => {
    await prisma.$disconnect()
  })

// we're ok to import from the test directory in this file
/*
eslint
  no-restricted-imports: "off",
*/

With this in place, we can run the seed file to populate our database with games and categories:

npm run setup

Checking the database

To verify that the seed file worked correctly, open the Prisma Studio:

npx prisma studio

You should see a list of article categories in the database:

Now that we’ve got some data in our database, we can move on to displaying it in our Remix app. 🚀