https://github.com/enriquebeta6/wordpress-boilerplate
A boilerplate template for theme development in WordPress
https://github.com/enriquebeta6/wordpress-boilerplate
docker react theme typescrip webpack wordpress
Last synced: about 2 months ago
JSON representation
A boilerplate template for theme development in WordPress
- Host: GitHub
- URL: https://github.com/enriquebeta6/wordpress-boilerplate
- Owner: enriquebeta6
- Created: 2021-01-24T20:47:24.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-24T20:47:59.000Z (over 5 years ago)
- Last Synced: 2025-08-01T10:58:06.665Z (10 months ago)
- Topics: docker, react, theme, typescrip, webpack, wordpress
- Language: PHP
- Homepage:
- Size: 185 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WordPress Boilerplate
## Requirements
- Yarn `v1.x`
- Node `v14.x`
## Get started
Install dependencies with Yarn
```bash
yarn
```
Start webpack server with
```bash
yarn start
```
Enjoy 🥳
If your browser doesn't open navigate to:
[http://localhost:9000](http://localhost:9000)
## Linters and Code Formatters
This project has some linters/code formatters like [eslint](https://eslint.org/) and [prettier](https://prettier.io/) to improve the code quality.
### For commits
We are using the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) and [commitlint](https://github.com/conventional-changelog/commitlint), so you need to follow [this rules](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional).
An example:
```
fix: prevent add products to minicart when the quantity is equal to 0
Fix #DEV_AZURE_WORK_ITEM_ID
```
### For branches
We have a linter for [git branch names](https://github.com/barzik/branch-name-lint#readme), so you can use these prefixes for your branch:
- feature (branch for a new feature).
- hotfix (branch for important bugfixes in production).
- bugfix (branch for bugfixes to be added in the next release).
The name of the git branches must be in lowercase.
An example:
```
feature/minicart-component
```
### For SCSS
We have a linter for the SCSS code, this lint use the follow config:
- [stylelint-selector-bem-pattern](https://github.com/simonsmith/stylelint-selector-bem-pattern).
- [stylelint-config-sass-guidelines](https://github.com/bjankord/stylelint-config-sass-guidelines).
## Build
```bash
yarn build
```