https://github.com/waldronmatt/base-boilerplate
Basic boilerplate repository to be reused for a variety of JavaScript-based projects.
https://github.com/waldronmatt/base-boilerplate
actionlint boilerplate commitizen commitlint dependabot editorconfig husky lint-staged markdownlint prettier secretlint semantic-pull-request semantic-release yamllint
Last synced: 3 months ago
JSON representation
Basic boilerplate repository to be reused for a variety of JavaScript-based projects.
- Host: GitHub
- URL: https://github.com/waldronmatt/base-boilerplate
- Owner: waldronmatt
- License: mit
- Created: 2022-09-18T16:00:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-26T21:24:45.000Z (over 2 years ago)
- Last Synced: 2024-12-31T11:57:24.182Z (5 months ago)
- Topics: actionlint, boilerplate, commitizen, commitlint, dependabot, editorconfig, husky, lint-staged, markdownlint, prettier, secretlint, semantic-pull-request, semantic-release, yamllint
- Language: JavaScript
- Homepage:
- Size: 313 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Base Boilerplate
Basic boilerplate repository to be reused for a variety of JavaScript-based projects.
## Installation
Install dependencies:
```bash
yarn
```
Install hooks:
```bash
yarn prepare
```
Install `make`:
```bash
[your-package-manager] install make
```
Install `yamllint` and `actionlint`.
## Commands
Commit changes using conventional changelog:
```bash
yarn commit
```
Lint files:
```bash
yarn lint
```
**Note**: `release.yml` will run this before versioning and publishing.
Lint `.yml` files:
```bash
make -f MAKEFILE
```
## License
MIT