Next.js Starter

This is a Next.js starter template that includes:

TypeScript

TypeScript adds additional syntax to JavaScript to support a tighter integration with your editor. Catch errors early in your editor.

Prettier

Formats your code for you.

lint-staged

Run the linter (ESLint) on staged git files

Husky

Lint commit messages, run tests, lint code, etc... when you commit or push.

Playwright

Playwright is a testing framework that lets you automate Chromium, Firefox, and WebKit with a single API. You can use it to write End-to-End (E2E) and Integration tests across all platforms.

Jest & Testing Library

Jest and React Testing Library are used together for Unit Testing.

Ladle

A lighter Storybook alternative for writing component stories.

Setup

With NPM:

npx create-next-app@latest --example https://github.com/ronsj/nextjs-starter

Getting Started

First, run the development server (example with NPM):

npm run dev

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

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

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in src/pages/api/hello.ts.

The src/pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.