For building and running the application you need:
Install the dependencies:
npm installRun the app in development environment:
npm run devUse a browser to navigate to http://localhost:3000/.
Branch name pattern:
type/description-in-kebab-case
type/issue-#{issue_number}
Examples:
feature/issue-#99
hotfix/quick-fix-for-an-emergency
Common types according to simplified convention for naming branches
- feature: adding, refactoring or removing a feature
- bugfix: fixing a bug
- hotfix: changing code with a temporary solution and/or without following the usual process (usually because of an emergency)
- test: experimenting outside of an issue/ticket
Commitlint checks if your commit messages meet the conventional commit format.
Commit message pattern:
type(scope?): subject #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")Examples:
chore: run tests on travis ci
fix(server): send cors headers
feat(blog): add comment section
Common types according to commitlint-config-conventional (based on the Angular convention) can be:
- build
- chore
- ci
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test
Read these references if needed: