k8o

This is a website for everything created by k8o!

setup

Install the package after preparing Node.js and pnpm with reference to the version described in package.json.

pnpm i --frozen-lockfile

Copy environment variables and launch docker to use SQL and KV.

cp .env.example .env.local
docker compose up -d
pnpm run migration

If you want to use the MicroCMS locally, ask k8o for the MICROCMS_API_KEY.

development

dev server

Starts the application in development mode with hot-code reloading, error reporting, and more.

pnpm run dev

storybook

There is a collection of components and a design system.

pnpm run storybook

tests

All tests is written by Vitest. It will run in browser mode except for the utils test. Storybook test is also with Vitest.

pnpm run test

# using Vitest UI
pnpm run test:ui

# If you want to get covarage result ...
pnpm run coverage

lint

Using elsint affected by Next.js.

pnpm run lint

format

By prettier.

pnpm run format

type-check

It work in typescript(tsc --noEmit).

pnpm run type-check

database

Generate migration file by schema file(src/database/schema.ts).

pnpm run generate

Generate custom migration file, such as seeding data.

pnpm run generage:custom

Execute database migration in migrations/*.sql.

pnpm run migrate

Connect local postgres database.

docker compose exec postgres psql -U postgres -d main

composition

platform

Application

Vercel

Database

Neon

KV

Upstash

CMS

MicroCMS

framework

next.js

styling

tailwdindcss

icon

heroicons

animation

motion