You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
An example template made using [Next.js and Typescript](https://nextjs.org/docs) to start a new project. The template is setup with [Prettier](https://prettier.io/docs/en/install.html), [ESLint](https://eslint.org/docs/user-guide/getting-started), [StyleLint](https://stylelint.io/user-guide/get-started) and [Lint Staged](https://github.com/okonet/lint-staged).
6
-
7
-
This template use next.js version 12.3.1. Read more about [release](https://github.com/vercel/next.js/releases/tag/v12.3.1)
5
+
This template was scaffolded from [nextjs-with-typescript-example-template](https://github.com/binodnepali/nextjs-with-typescript-example-template). And this template adds [tailwindcss](https://tailwindcss.com/) so that you can start a new project using [Next.js](https://nextjs.org/) and [tailwindcss](https://tailwindcss.com/).
8
6
9
7
## Why this template
10
8
11
-
I made this template because I have to set up every time Prettier, ESLint, StyleLint and Lint Staged for my new next.js projects. And I thought this might be useful for developers who are looking for configuration or starter or example templates.
9
+
This template includes pre-installed plugins suchas [prettier](https://prettier.io/), [eslint](https://eslint.org/), [stylelint](https://stylelint.io/), [lint-staged](https://github.com/okonet/lint-staged), [commitlint](https://commitlint.js.org/) and [standard version](https://github.com/conventional-changelog/standard-version) which helps to maintain project code quality.
12
10
13
11
## Before getting started
14
12
@@ -18,20 +16,20 @@ Make sure you have installed [Node.js 12.22.0 or higher](https://nodejs.org/en/)
18
16
19
17
You can setup this project using npm or yarn package managers.
20
18
21
-
> I would recommend to installed or enabled [yarn](https://yarnpkg.com/getting-started) package manager on your machine.
19
+
> I would recommend to installed or enabled [yarn 3.1.1 or higher](https://yarnpkg.com/getting-started) package manager on your machine.
Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/) in your repository. And when you're ready to release, run below scripts.
@@ -103,4 +111,5 @@ To learn more about Next.js, ESLint, Prettier, StyleLint and lint-staged, take a
103
111
*[ESLint Setup](https://eslint.org/docs/user-guide/getting-started) - Learn about how to ESLint
104
112
*[StyleLint Setup](https://stylelint.io/user-guide/get-started) - Learn about how to setup StyleLint
105
113
*[Lint Staged Setup](https://github.com/okonet/lint-staged) - Learn about how to setup lint-staged
114
+
*[commitlint](https://commitlint.js.org/) - Learn about how to use commit lint
106
115
*[Standard Version](https://github.com/conventional-changelog/standard-version) - Learn about how to setup standar version
0 commit comments