antonaduisky / webpack-react-typescript Goto Github PK

Template for react app using webpack and typescript.

Start the development

• git clone
• yarn install or yarn
• yarn start

Build project

• yarn build

Lint project

• yarn lint

Fix autofixable eslint errors

• yarn lint:fix or npm run lint:fix

If husky pre-commit hook willn't work, please run npx husky-init command with cli (in project directory)
and replace new .husky/pre-commit file with our.

• React 18 as a front-end library.
• Webpack 5 as a bundler.
• TypeScript for type checking.
• React Router v6 for application routing.
• eslint for lint code.
• prettier for format code.
• husky for run any script before commit.
• commitlint for conventional commit messages.

We are use commitlint for lint our commit messages and it has several rules for commits.

Commit types

• chore: a commit of the type chore includes the most important commits.
• docs: a commit of the type docs includes the update of documentation.
• feat: a commit of the type feat introduces a new feature to the codebase.
• fix: a commit of the type fix patches a bug in your codebase.
• style: a commit of the type style includes a css styling commit.
• refactor: a commit of the type refactor includes a code refactoring to the codebase.
• revert: a commit of the type revert is used when a developer wants to revert an old commit.
• unit: a commit of the type unit includes a unit testing commit.
• test: a commit for a testing the app work at difference environments
• wip: work in process

Examples

    git commit -m "feat(readme): generate a readme file"
    git commit -m "fix(header): show current banner"
    git commit -m "chore(release): new release is ready"