https://github.com/enmanuelmag/musketeersv3
https://github.com/enmanuelmag/musketeersv3
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/enmanuelmag/musketeersv3
- Owner: enmanuelmag
- License: other
- Created: 2024-02-27T03:41:17.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-28T16:44:30.000Z (over 1 year ago)
- Last Synced: 2025-01-31T22:52:42.758Z (5 months ago)
- Language: TypeScript
- Size: 959 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Musketeers V3
> Boilerplate for React/Typescript/Server, built on top of Vite and Typescript
# What's in the boilerplate
- [Vite](https://vitejs.dev/)
- [React](https://reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [Vitest](https://vitest.dev/)
- [Testing Library](https://testing-library.com/)
- [ExpressJs](https://expressjs.com/)
- [Global types with Zod](https://zod.dev)
- [Zustand](https://zustand-demo.pmnd.rs)
- Dev Tools
- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [CommitLint](https://commitlint.js.org/#/)
- [Husky](https://typicode.github.io/husky/#/)
- [Lint-Staged](https://github.com/okonet/lint-staged)
# Commits
This project have commits configured to follow the Conventional Commits's best practice and it's configured with ESLint, Prettier and Stylelint.
To commit, you must follow the convention `[optional scope]: `. In practice, it would be as follow:
```git
git commit -m "feat: add button component"
```
Then, Husky will start the pre-commit hook and run lint-staged, who will run `prettier`, `lint` and `stylelint` to validate code format and code lint. If you fail to follow any of these validations, the commit will be aborted.
After that, if everything is validated correctly, Husky will proceed with the commit-msg hook, where it will evaluate if your commit message is following the Conventional Commit's best practice and later run the tests of your project. If any of the tests are broken, the commit will be aborted. You must fix the tests before proceed.
You can also commit your files with the help of the CLI. To do so, just run `npm run commit`. From there, the CLI will assist you in the proccess. As before: if your changes fails the validation, you must fix it before proceed.
As a best practice, it is strongly recommended that you do not skip the validations. If you need to change the way your commit messages are written, just go to file `commitlint.config.ts` and you will find there the config needed.
Check out [commitlint](https://commitlint.js.org/#/) docs to see further configurations that you can do.
# License
MIT