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
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 withnpm install
, and change the CI workflows, Husky Git hooks, and lint-staged steps to use npm commands.
yarn
;yarn dev
;
To view the project open http://localhost:3000
.
- Fork this repository;
- Create your branch:
git checkout -b my-new-feature
; - Commit your changes:
git commit -m 'Add some feature'
; - Push to the branch:
git push origin my-new-feature
.
After your pull request is merged, you can safely delete your branch.
This project is licensed under the MIT License - see the LICENSE.md file for more information.
Made with β₯ by JoΓ£o Pedro Schmitz