Skip to content

README.md

Latest commit

 

History

History
112 lines (71 loc) · 2.44 KB

README.md

File metadata and controls

112 lines (71 loc) · 2.44 KB

logo

Blueprint

license last commit checked with biome

This monorepo blueprint allows you to kickstart your projects with Bun, Turborepo, Biome and TypeScript.

Take advantage of the pre-configured setup to accelerate your development process with the efficiency of modern tools.

Apps

@blueprint/with-hono

This is a blueprint for a REST API with Hono.

🔌 Port 8000

💎 README

@blueprint/with-next

This is a blueprint for a web app with Next.js.

🔌 Port 3000

💎 README

@blueprint/with-orpc

This is a blueprint for a typesafe API with oRPC.

🔌 Port 4000

💎 README

Getting Started

Important

Prerequisite is the global installation of Bun as runtime, Turborepo for task orchestration and optionally Docker for containerization.

  1. Clone the blueprint: bunx degit kporten/blueprint my-project
  2. Follow the setup instructions in each app blueprint that you want to use.
  3. Install the dependencies: bun install
  4. Start the development servers: turbo dev

🎉 Now you can get up and running with your ideas!

Tasks

Development

# start development servers
turbo dev

# build apps
turbo build

# check types
turbo typecheck

# execute tests
turbo test

# execute tests in watch mode
turbo test:watch

Quality

# check format and lint
turbo check

# fix format and lint issues
turbo check:fix

Database

# generate database migrations
turbo db:generate

# apply database migrations
turbo db:migrate

# check database migrations
turbo db:check

# push database schemas
turbo db:push

# seed database data
turbo db:seed

Note

Configuration: turbo.json

Docker

# build docker images
docker compose build

# start docker containers
docker compose up