StartKit

A sane starting point for Next.js projects.

Features

Next.js 13.2 with the /app directory
Typescript for a rock-solid codebase
ESLint + Prettier for readable, safe code.
TailwindCSS for utility-first CSS.
The beautiful Inter typeface.
Next Metadata API for SEO handling.
Jest testing, optimized for Next.js
Automatic Dark Mode support (based on system setting).
Sane VSCode settings and recommended extensions

Starting a new project with StartKit

Clone this repo to your desired path:

git clone git@github.com:startkit-dev/startkit-next.git my-new-project

Rename the project:
```
./bin/rename
```
Update your git remote to point to StartKit as upstream
```
git remote rename origin upstream
```
In the future, you'll be able to pull in the latest StartKit changes without missing a beat by running:
```
git fetch upstream
git pull upstream/main
```

Getting Started

pnpm run setup

Running the server

pnpm run dev

The app will be running at http://localhost:3000.

Naming the project

The StartKit name is used throughout the project, you should find and replace the following strings with your project name:

StartKit
startkit
start_kit
START_KIT

A helper script has been included to make this easier:

./bin/rename