https://github.com/timelessco/react-js-template
React JS Project template
https://github.com/timelessco/react-js-template
eslint husky react-js template
Last synced: 5 months ago
JSON representation
React JS Project template
- Host: GitHub
- URL: https://github.com/timelessco/react-js-template
- Owner: timelessco
- License: mit
- Created: 2020-12-07T06:50:45.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T14:53:44.000Z (over 2 years ago)
- Last Synced: 2023-12-15T15:58:23.800Z (over 2 years ago)
- Topics: eslint, husky, react-js, template
- Language: HTML
- Homepage:
- Size: 458 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React JS Template
React JS Project Boilerplate
## Get Started
`yarn`
## Local Development
> Start the development server
`yarn start`
## Run Tests
> Run all yours test files
`yarn test`
## Build
> Build the site into `build` folder
`yarn build`
## Eslint
> Extend **react-app** configs & **react-app/jest** configs
> Check for the linting errors
`yarn lint`
> Check & automatically fix the linting errors
`yarn lint:fix`
## Prettier
> Used in conjuction with Eslint with `eslint-plugin-prettier` &
> `eslint-config-prettier`
> Format the workspace files
`yarn format`
> Format the `package.json` file
`yarn format:package`
## Commit
`git add . && yarn commit`
> Uses **[gacp](https://github.com/vivaxy/gacp#readme)**
- Runs [Husky](https://github.com/typicode/husky) to improve the commits.
- Husky runs [Lint Staged](https://github.com/okonet/lint-staged) as a
pre-commit hook to run lintes & formatters
- Husky lints the commit message with
[Commitlint](https://github.com/conventional-changelog/commitlint)