TypeScript starter for Next.js

All you need to build your next project.

_{Created by Claudio Orlandi.}

Features

• ⚡️ Next.js 15 (App Router)
• ⚛️ React 19
• ⛑ TypeScript
• 📏 ESLint 9 — To find and fix problems in your code
• 💖 Prettier — Code Formatter for consistent style
• 🐶 Husky — For running scripts before committing
• 🚓 Commitlint — To make sure your commit messages follow the convention
• 🚫 lint-staged — Run ESLint and Prettier against staged Git files
• 👷 PR Workflow — Run Type Check & Linters on Pull Requests
• ⚙️ EditorConfig - Consistent coding styles across editors and IDEs
• 🗂 Path Mapping — Import components or images using the @ prefix
• 🔐 CSP — Content Security Policy for enhanced security (default minimal policy)
• 🧳 T3 Env — Type-safe environment variables

Quick Start

The best way to start with this template is using Create Next App.

# yarn
yarn create next-app -e https://github.com/csorlandi/nextjs-starter
# pnpm
pnpm create next-app -e https://github.com/csorlandi/nextjs-starter
# npm
npx create-next-app -e https://github.com/csorlandi/nextjs-starter

Development

To start the project locally, run:

yarn dev

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

Documentation

Requirements

• Node.js >= 20
• yarn

Directory Structure

• .github — GitHub configuration including the CI workflow.
  
• .husky — Husky configuration and hooks.
  
• public — Static assets such as robots.txt, images, and favicon.
  
• src — Application source code, including pages, components, styles.

Scripts

• yarn dev — Starts the application in development mode at http://localhost:3000.
• yarn build — Creates an optimized production build of your application.
• yarn start — Starts the application in production mode.
• yarn type-check — Validate code using TypeScript compiler.
• yarn lint — Runs ESLint for all files in the src directory.
• yarn lint:fix — Runs ESLint fix for all files in the src directory.
• yarn format — Runs Prettier for all files in the src directory.
• yarn format:check — Check Prettier list of files that need to be formatted.
• yarn format:ci — Prettier check for CI.

Path Mapping

TypeScript are pre-configured with custom path mappings. To import components or files, use the @ prefix.

import { Button } from '@/components/Button';
// To import images or other files from the public folder
import avatar from '@/public/avatar.png';

Environment Variables

We use T3 Env to manage environment variables. Create a .env.local file in the root of the project and add your environment variables there.

When adding additional environment variables, the schema in ./src/lib/env/client.ts or ./src/lib/env/server.ts should be updated accordingly.

CSP (Content Security Policy)

The Content Security Policy (CSP) is a security layer that helps to detect and mitigate certain types of attacks, including Cross-Site Scripting (XSS) and data injection attacks. The CSP is implemented in the next.config.ts file.

It contains a default and minimal policy that you can customize to fit your application needs. It's a foundation to build upon.

License

This project is licensed under the MIT License - see the LICENSE file for more information.