Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timonwa/nextjs-typescript-boilerplate
A starter template for Next.js with TypeScript. Kickstart your Next.js projects with built-in linting, formatting, and commit message checks.
https://github.com/timonwa/nextjs-typescript-boilerplate
commitlint commitlint-config husky husky-hooks lint-staged lint-staged-config nextjs nextjs-boilerplate nextjs-template nextjs-typescript nextjs-typescript-boilerplate nextjs-typescript-template precommit precommit-hooks prettier prettier-config prettier-eslint
Last synced: 25 days ago
JSON representation
A starter template for Next.js with TypeScript. Kickstart your Next.js projects with built-in linting, formatting, and commit message checks.
- Host: GitHub
- URL: https://github.com/timonwa/nextjs-typescript-boilerplate
- Owner: Timonwa
- License: mit
- Created: 2023-10-13T19:04:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-21T20:51:24.000Z (about 1 year ago)
- Last Synced: 2023-12-21T21:30:16.586Z (about 1 year ago)
- Topics: commitlint, commitlint-config, husky, husky-hooks, lint-staged, lint-staged-config, nextjs, nextjs-boilerplate, nextjs-template, nextjs-typescript, nextjs-typescript-boilerplate, nextjs-typescript-template, precommit, precommit-hooks, prettier, prettier-config, prettier-eslint
- Language: CSS
- Homepage:
- Size: 133 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Next.js TypeScript Boilerplate
A starter template for Next.js with TypeScript. Kickstart your Next.js projects with built-in linting, formatting, and commit message checks.
## 📐 Architecture
This project is designed to help you get started quickly with Next.js and TypeScript. It includes the following key technologies:
- [Next.js](https://nextjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Prettier](https://prettier.io/)
- [Commitlint](https://commitlint.js.org/#/)
- [Husky](https://typicode.github.io/husky/#/)
- [Lint-staged](https://github.com/okonet/lint-staged)
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.
## 🚀 Getting Started
### Installation
1. Fork this repository to your own GitHub account.
2. Clone the repository to your local machine:
```bash
git clone https://github.com/yourusername/nextjs-typescript-boilerplate.git
```
3. Install project dependencies:
```bash
npm install
```
4. Start the development server:
```bash
npm run dev
```
5. Open your web browser and navigate to [http://localhost:3000](http://localhost:3000) to see your Next.js application in action.
## 🧰 Features
- **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.
## 📄 License
This project is open-source and available under the [MIT License](LICENSE). Feel free to use, modify, and distribute it according to your needs.
## 🙏 Acknowledgments
Special thanks to the creators of the technologies that make this starter template possible:
- [Next.js](https://nextjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Prettier](https://prettier.io/)
- [Commitlint](https://commitlint.js.org/#/)
- [Husky](https://typicode.github.io/husky/#/)
- [Lint-staged](https://github.com/okonet/lint-staged)