Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 1.41 KB

README.md

File metadata and controls

52 lines (38 loc) · 1.41 KB

startkit-next

A sane way to start your next Next.js project

A type-safe starter project following the latest best practices

Features

  • ✅ The latest Next.js (v15 rc)
  • ✅ Bun package manager and test runner
  • ✅ Complete type-aware linting with Eslint 9
  • ✅ Beautiful code-style from Prettier
  • ✅ Automatic CI with Github Actions
  • ✅ Type-safe environment variables via t3-env
  • ✅ Tailwind CSS for utility-first CSS
  • ✅ Automatic sitemap.xml, robots.txt, and manifest generation

Installation

git clone git@github.com:startkit-dev/next.git <your-project-name>

Once cloned, you can run the setup script to get everything initialized:

bun run setup

Usage

bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Scripts

The project comes with some useful scripts.

bun check         - Perform a full check of the repo (lint, format, test, and type-check)
bun fix           - Fix any lint and formatting issues
bun lint          - Lint the repository
bun format:check  - Check the formatting of the repository
bun format        - Fix any formatting issues
bun run outdated  - Find any outdated packages