Next.js Starter Template

A fully configured Next.js starter template with modern tools for streamlined development.

Features

• Next.js (App Router) – Utilizes the latest Next.js App Router for modern routing and server components
• TypeScript – Static typing for maintainable code
• Tailwind CSS – Utility-first styling framework
• shadcn/ui – Beautiful and accessible UI components
• ESLint & Prettier – Linting and code formatting
• Husky & lint-staged – Pre-commit hooks for better code quality
• CommitLint – Enforces commit message conventions

Getting Started

Prerequisites

Ensure you have the following installed:

• Node.js (LTS recommended)
• Yarn or npm

Installation

Clone the repository and install dependencies:

git clone https://github.com/Louai-Zockerburg/nextjs-starter-repo.git
cd nextjs-starter
pnpm install  # or yarn install

Running the Development Server

Start the local development server:

pnpm dev  # or yarn dev

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

Code Linting & Formatting

Run ESLint and Prettier manually:

pnpm lint  # or yarn lint
pnpm format  # or yarn format

Pre-commit Hooks & Commit Message Linting

Husky and lint-staged ensure code quality before commits, and CommitLint enforces proper commit message format:

git commit -m "your commit message"

Build for Production

Generate a production build:

pnpm build  # or yarn build

Project Structure

nextjs-starter/
├── public/        # Static assets
├── src/
│   ├── app/       # Next.js App Router pages and layouts
│   ├── components/ # Reusable UI components
│   ├── hooks/      # Custom React hooks
│   ├── lib/        # Utility functions and shared logic
│   ├── styles/     # Global styles
│   ├── config/     # Configuration files
├── .commitlintrc   # CommitLint config
├── .eslintrc.json  # ESLint config
├── .prettierrc     # Prettier config
├── package.json    # Project metadata & scripts
├── next.config.ts  # Next.js configuration
├── README.md       # Documentation
└── tsconfig.json   # TypeScript configuration

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.