A TypeScript starter for Next.js that includes all you need to build amazing projects 🔥

• 📏 ESLint — Pluggable JavaScript linter
• 💖 Prettier - Opinionated Code Formatter
• 🐶 Husky — Use git hooks with ease
• 📄 Commitizen - Conventional commit messages CLI
• 🚓 Commitlint - Lint commit messages
• 🖌 Renovate - Dependency update tool
• 🚫 lint-staged - Run linters against staged git files
• 👷 PR Workflow - Run Type Check & Linters on pull requests
• 🗂 Absolute import - Import folders and files using the

  @

  prefix

🚀 Getting started

The best way to start with this template is using

create-next-app

npx create-next-app ts-next -e https://github.com/jpedroschmitz/typescript-nextjs-starter

If you prefer you can clone this repository and run the following commands inside the project folder:

By default, this starter uses Yarn, but this choice is yours. If you'd like to switch to npm, delete the

yarn.lock

file, install the dependencies with

npm install

, and change the CI workflows, Husky Git hooks, and lint-staged steps to use npm commands.

1. yarn

   ;

2. yarn dev

   ;

To view the project open

http://localhost:3000

🤝 Contributing

1. Fork this repository;
2. Create your branch:

   git checkout -b my-new-feature

   ;
3. Commit your changes:

   git commit -m 'Add some feature'

   ;
4. Push to the branch:

   git push origin my-new-feature

   .

After your pull request is merged, you can safely delete your branch.

📝 License

This project is licensed under the MIT License - see the LICENSE.md file for more information.

Made with ♥ by João Pedro Schmitz