Skip to content
/ nextjs-template Public template

A robust Next.js template to kickstart your web projects. This template includes essential tools and configurations to streamline development.

Notifications You must be signed in to change notification settings

code-sensei/nextjs-template

Repository files navigation

Next.js Template


A robust Next.js template to kickstart your web projects. This template includes essential tools and configurations to streamline development.

Features

  • Next.js: The React framework for production.
  • TypeScript: For static type checking.
  • Tailwind CSS: Utility-first CSS framework.
  • ESLint: Linting utility to maintain code quality.
  • Prettier: Code formatter to ensure consistent styling.
  • Husky: Git hooks to enforce quality checks.
  • PostCSS: Tool for transforming CSS with JavaScript plugins.

Getting Started

Prerequisites

  • Node.js
  • npm, yarn, pnpm, or bun

Installation

Clone the repository:

git clone https://github.com/code-sensei/nextjs-template.git
cd nextjs-template

Install dependencies:

npm install
# or
yarn install
# or
pnpm install
# or
bun install

Development

Run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 to view it in your browser. The page auto-updates as you make edits.

Building for Production

To create an optimized production build:

npm run build
# or
yarn build
# or
pnpm build
# or
bun build

Linting and Formatting

Lint your code with:

npm run lint
# or
yarn lint
# or
pnpm lint
# or
bun lint

Format your code with:

npm run format
# or
yarn format
# or
pnpm format
# or
bun format

Commit Hooks

This template uses Husky to run linting and formatting checks before each commit.

Learn More

Contributing

Feel free to fork this repository, create a branch, and submit a pull request.

License

This project is licensed under the MIT License.

About

A robust Next.js template to kickstart your web projects. This template includes essential tools and configurations to streamline development.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published