A starter template for Next.js with TypeScript. Kickstart your Next.js projects with built-in linting, formatting, and commit message checks.
This project is designed to help you get started quickly with Next.js and TypeScript. It includes the following key technologies:
Upon each commit, the following checks are automatically performed:
- Linting: Ensure your code follows consistent coding standards.
- Prettier: Automatically format your code for consistent style.
- Commit Message Format: Enforce clear and standardized commit messages.
-
Fork this repository to your own GitHub account.
-
Clone the repository to your local machine:
git clone https://github.com/yourusername/nextjs-typescript-boilerplate.git
-
Install project dependencies:
npm install
-
Start the development server:
npm run dev
-
Open your web browser and navigate to http://localhost:3000 to see your Next.js application in action.
- TypeScript: Write your code with the benefits of static typing.
- Next.js: Enjoy server-side rendering, routing, and more.
- Prettier: Keep your codebase consistently formatted.
- Commitlint: Enforce commit message conventions for better collaboration.
- Husky: Easily manage Git hooks.
- Lint-staged: Run linters on pre-committed files only.
This project is open-source and available under the MIT License. Feel free to use, modify, and distribute it according to your needs.
Special thanks to the creators of the technologies that make this starter template possible: