Skip to content
/ nextjs-template Public template

Minimal template / boilerplate / starter for Next.js ⚡️ Stack: Next.js + TypeScript + ESLint + Prettier + Husky + Lint-Staged + Commitlint + Tailwind

License

Notifications You must be signed in to change notification settings

disin8/nextjs-template

Repository files navigation

nextjs-template

A minimal Next.js TypeScript template.

  • Next.js — The React Framework
  • 📏 ESLint — Pluggable JavaScript linter
  • 🔥 Typescript - Type checking TypeScript
  • 💎 Tailwind CSS - Integrate with Tailwind CSS
  • 💖 Prettier — Opinionated Code Formatter
  • 🐶 Husky — Use git hooks with ease
  • 🚓 Commitlint — Lint commit messages
  • 🚫 lint-staged — Run linters against staged git files
  • 🗂 Absolute import — Import folders and files using the @ prefix

🚀 Getting started

Run the following commands inside the project folder:

  1. npm install
  2. npm run 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.