Contents

• Getting started
• Conventional Commit
  • Benefits using commitlint
• How use Linter

---

Getting Started

First, install all necessary dependencies:

npm install
# or
yarn install

Then, development server. Hint: The project use concurrently. please check packge.json scripts section.

npm start
# or
yarn start

Open http://localhost:3000 with your browser to see the result. If you want to see json server in the browser, open http://localhost:3001.

Conventional Commit

You're able to use conventional commit in this project.

git add .

# then

npm run commit
# or
yarn commit

Benefits using commitlint

• Why Use Conventional Commits?
• "The perks of committing with conventions" (Talk slides)

For Linter

This project have default eslint configured, you can execute it in this way:

npm run eslint .
# or
yarn eslint .