Skip to content

Commit 5630e09

Browse files
committed
chore: update README doc and package.json
1 parent 5761b47 commit 5630e09

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22

33
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
44

5-
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/).
86

97
## Why this template
108

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.
1210

1311
## Before getting started
1412

@@ -18,20 +16,20 @@ Make sure you have installed [Node.js 12.22.0 or higher](https://nodejs.org/en/)
1816

1917
You can setup this project using npm or yarn package managers.
2018

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.
2220
2321
### Clone repo
2422

2523
```bash
26-
git clone https://github.com/binodnepali/nextjs-with-typescript-example-template.git
24+
git clone https://github.com/binodnepali/nextjs-with-tailwindcss-example-template.git
2725
#or
28-
git clone [email protected]:binodnepali/nextjs-with-typescript-example-template.git
26+
git clone [email protected]:binodnepali/nextjs-with-tailwindcss-example-template.git
2927
```
3028

3129
### Navigate to cloned repo
3230

3331
```bash
34-
cd nextjs-with-typescript-example-template
32+
cd nextjs-with-tailwindcss-example-template
3533
```
3634

3735
### Install dependencies
@@ -82,6 +80,16 @@ yarn commit
8280
npm run commit
8381
```
8482

83+
### Run first release
84+
85+
This will create initial release.
86+
87+
```bash
88+
yarn release:first
89+
#or
90+
npm run release:first
91+
```
92+
8593
### Run release
8694

8795
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
103111
* [ESLint Setup](https://eslint.org/docs/user-guide/getting-started) - Learn about how to ESLint
104112
* [StyleLint Setup](https://stylelint.io/user-guide/get-started) - Learn about how to setup StyleLint
105113
* [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
106115
* [Standard Version](https://github.com/conventional-changelog/standard-version) - Learn about how to setup standar version

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
"build": "next build",
1212
"start": "next start",
1313
"release": "standard-version",
14+
"release:first": "yarn release --first-release",
1415
"prepare": "husky install",
1516
"commit": "git-cz"
1617
},

0 commit comments

Comments
 (0)