https://github.com/levdbas/basebuilder
https://github.com/levdbas/basebuilder
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/levdbas/basebuilder
- Owner: Levdbas
- Created: 2019-03-08T11:32:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T14:01:13.000Z (over 1 year ago)
- Last Synced: 2025-03-15T11:45:14.669Z (over 1 year ago)
- Language: JavaScript
- Size: 3.41 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BaseBuilder
BaseBuilder is a Webpack config in the form of an NPM module that can handle most WP projects.
Works best in combination with [BasePlate](https://github.com/Levdbas/BasePlate 'Check out BasePlate') WP starter theme
## How to install
### 1. Remove old devDependencies from your projects `package.json` file.
### 2. Add basebuilder
```bash
yarn add basebuilder-config
```
### 3. Add following scripts to package.json
```json
"scripts": {
"dev": "npm run development",
"development": "basebuilder-config development",
"watch": "basebuilder-config watch",
"production": "basebuilder-config production"
},
```
### 4. Make sure the following file exist: `resources/assets/config.json`
An example config file is located in `node_modules/basebuilder-config/config.json`
## How to eject
We'll probably make an eject script in the future. For now. Do the following steps:
1. add packages from `basebuilder-config/package.json` to your own `package.json`.
2. add the following scripts to your `package.json`.
```json
"scripts": {
"dev": "npm run development",
"development": "NODE_ENV=development webpack --mode development --config assets/build/webpack.config.js",
"watch": "NODE_ENV=development webpack --mode development --watch --config assets/build/webpack.config.js",
"production": "NODE_ENV=production webpack --mode production --config assets/build/webpack.config.js"
},
```
3. copy `basebuilder-config/build` folder to your projects assets folder in the project root.
## Overwrite config.json file location
Normally BaseBuilder checks for the config.json in the assets folder in the root of the project dir.
If you want to overwrite it you can set
```json
"config": {
"userConfig": "/web/app/themes/yourtheme/resources/assets/config.json"
},
```
in the package.json.