https://github.com/stevygee/master-builder
A reusable SCSS / JS builder for WordPress themes / plugins
https://github.com/stevygee/master-builder
builder tooling
Last synced: 2 months ago
JSON representation
A reusable SCSS / JS builder for WordPress themes / plugins
- Host: GitHub
- URL: https://github.com/stevygee/master-builder
- Owner: stevygee
- License: mit
- Created: 2019-04-10T21:38:35.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-29T18:02:37.000Z (about 1 year ago)
- Last Synced: 2024-04-22T12:15:04.174Z (about 1 year ago)
- Topics: builder, tooling
- Language: JavaScript
- Homepage:
- Size: 881 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Master Builder
A reusable SCSS / JS builder, now based on esbuild!
### Requirements
- Node 12
### Features
- Super fast!
- JSX
- Sass / SCSS
- PostCSS
- Autoprefixer
- Browserslist support
- Copy additional files
- Compress all files into a ZIP
- etc.
### Getting started
1. Add scripts to your project's package.json:
```
"scripts": {
"start": "master-builder",
"build": "master-builder build",
"deploy": "master-builder deploy"
},
```
2. ```npm install @stevygee/master-builder --save-dev```
3. ```npm start```
Optional: Copy `.master-builder`, `.browserslistrc` config files to your project and configure to your needs!
### Building for production
1. ```npm run build```
### Building for production and create a zip file
1. ```npm run deploy```
2. Upload the zip file in dist/packages for use in WordPress (install theme/plugin).
### Development
1. Checkout this repo
3. ```npm install```
4. Instead of `npm start`, use `node bin/index.js` or `node bin/index.js deploy` to build the example files
### Development using your project
How to add as a local dependency:
1. Checkout this repository in a sibling directory next to your project
2. Change the dependency path in your project's package.json:
```
"devDependencies": {
...
"@stevygee/master-builder": "../master-builder"
}
```
3. Use ```npm install``` to continously update the package after you've made a change.
