Next.js 13 Starter Template

Template for a Next.js 13 application. It is preconfigured with TypeScript, ESLint, Prettier, Tailwind CSS, Shadcn UI, and many more features to kick-start your Next.js development.

Features

Next.js 13 App Directory
Radix UI Primitives
Tailwind CSS
Icons from Lucide
Dark mode with next-themes

Requirements

Before starting, make sure you have Node.js and pnpm installed on your system.

Node.js 12.0+
pnpm 6.0+

Getting Started

Using create-next-app

To create a new project based on this template, run:

pnpx create-next-app <name> -e https://github.com/PaoloJN/next-template

Clone the Repository

First, clone this repository to your local machine:

git clone https://github.com/PaoloJN/next-template.git
cd <name>

Install Dependencies

To install the required dependencies, run:

pnpm install

Run the Application

You can start the development server with:

pnpm run dev

Then, open http://localhost:3000 in a browser.

Available Scripts

In the project directory, you can run:

pnpm run dev - Starts the development server.
pnpm run build - Builds the app for production.
pnpm start - Runs the built app in production mode.
pnpm run lint - Lints the codebase using Next.js lint.
pnpm run preview - Builds the app and starts it in production mode for previewing.
pnpm run format:write - Formats the codebase using Prettier and writes the changes.
pnpm run format:check - Checks if the codebase is formatted correctly using Prettier.

Contributing

Contributions are welcome! Please see our contributing guidelines for more details.

License

This project is licensed under the terms of the MIT license.

Support

If you're having any problem, please raise an issue on GitHub.

Happy coding!