/next-starter

A Next.js starter template powered by TypeScript, styled with TailwindCSS and Shadcn/ui. Features include dark mode, SEO optimization, and pre-configured Eslint, Prettier, Husky, and Lint-staged settings. Jumpstart your project with efficiency and style!

Primary LanguageTypeScriptMIT LicenseMIT

thumbnail

Features

  • πŸš€ Next.js 14 (App router)
  • βš›οΈ React 18
  • πŸ“˜ Typescript
  • 🎨 TailwindCSS - Class sorting, merging and linting
  • πŸ› οΈ Shadcn/ui - Customizable UI components
  • πŸ§ͺ Jest & React Testing Library - Configured for unit testing
  • πŸ“ˆ Absolute Import & Path Alias - Import components using @/ prefix
  • πŸ’… Prettier - Code formatter
  • 🧹 Eslint - Code linting tool
  • 🐢 Husky & Lint Staged - Run scripts on your staged files before they are committed
  • πŸ”Ή Icons - From Lucide
  • πŸŒ‘ Dark mode - With next-themes
  • πŸ—ΊοΈ Sitemap & robots.txt - With next-sitemap
  • πŸ“ Commitlint - Lint your git commits
  • πŸ€– Github actions - Lint your code on PR

Getting started

1. Clone this template in one of three ways

  1. Using this repository as template

    use-this-template-button

  2. Using create-next-app

    npx create-next-app -e https://github.com/Skolaczk/next-starter my-project-name

  3. Using git clone

    git clone https://github.com/Skolaczk/next-starter my-project-name

2. Install dependencies

npm install

3. Prepare husky

It is required if you want husky to work

npm run prepare

4. Run the dev server

You can start the server using this command:

npm run dev

and open http://localhost:3000/ to see this app.

If you liked the project, I will appreciate if you leave a star. 🌟😊

Made by MichaΕ‚ Skolak