Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wwwebman/gulp-webpack-starter
Gulp Webpack Starter - fast static website builder. The starter uses gulp toolkit and webpack bundler. Download to get an awesome development experience!
https://github.com/wwwebman/gulp-webpack-starter
browsersync gulp gulp-starter gulp-tasks static-site-generation static-site-generator svg-sprites templates webpack webpack-configuration webpack-starter wordpress-development yarn
Last synced: 7 days ago
JSON representation
Gulp Webpack Starter - fast static website builder. The starter uses gulp toolkit and webpack bundler. Download to get an awesome development experience!
- Host: GitHub
- URL: https://github.com/wwwebman/gulp-webpack-starter
- Owner: wwwebman
- License: mit
- Created: 2017-02-02T11:00:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T20:43:12.000Z (about 1 year ago)
- Last Synced: 2024-04-14T15:58:00.279Z (6 months ago)
- Topics: browsersync, gulp, gulp-starter, gulp-tasks, static-site-generation, static-site-generator, svg-sprites, templates, webpack, webpack-configuration, webpack-starter, wordpress-development, yarn
- Language: JavaScript
- Homepage:
- Size: 3.56 MB
- Stars: 216
- Watchers: 16
- Forks: 41
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
**Gulp Webpack Starter** - fast and simple web development toolkit.
It uses Gulp task runner and Webpack bundler.
The starter perfectly fits [building static HTML templates](#dart-1-static-html-templating)
or [speeding up WordPress](#eyes-2-wordpress) theme development.
[Version 2](https://github.com/wwwebman/gulp-webpack-starter/releases/tag/v2.0.0) is released :tada:.
**Easy to start, nice to use. Check it out! :octopus:**
___
## List of Content
1. [Features](#gift-features)
1. [Getting Started?](#getting-started)
* [Recommendations](#closed_book-recommendations)
* [Static HTML templating](#dart-1-static-html-templating)
* [WordPress](#eyes-2-wordpress)
1. [Contributing](./CONTRIBUTING.md)
1. [Examples](./examples)
## :gift: Features
|Features|Description|
|------------------|-----------|
|CSS| [SASS](http://sass-lang.com/), [Autoprefixer](https://github.com/postcss/autoprefixer), [gulp-purgecss](https://www.npmjs.com/package/gulp-purgecss)|
|JS|[Webpack](https://webpack.js.org/), [Babel](http://babeljs.io/)|
|Live Reload|[BrowserSync](http://www.browsersync.io/), [Webpack Dev Middleware](https://github.com/webpack/webpack-dev-middleware), [Webpack Hot Middleware](https://github.com/glenjamin/webpack-hot-middleware)|
|HTML| [gulp-file-include](https://www.npmjs.com/package/gulp-file-include)|
|Images| [gulp-imagemin](https://www.npmjs.com/package/gulp-imagemin)|
|SVG sprite| [gulp-svg-sprite](https://github.com/jkphl/gulp-svg-sprite)|
## Getting started?
### :closed_book: Recommendations
Make sure you have installed the following:
* [Node.js](https://nodejs.org/)(**Recommended to use Node.js v10.16.0**)
* [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/en/).
In this tutorial we use yarn, but you can use npm.
## :dart: 1. Static HTML templating
#### Step 1 - clone
```bash
git clone https://github.com/wwwebman/gulp-webpack-starter [my-static-template-project-name]
cd [my-static-template-project-name]
```
#### Step 2 - run
`cp .env.dist .env`
```bash
yarn
yarn start
```
Start files modification under `[my-static-template-project-name]/dev/*` to feel a great
development experience.
**Cool and pretty easy, right?**
***
## :eyes: 2. WordPress
### 1. Preparation
It can be setup in a number of different ways, but we would like to describe the simplest:
Please be sure of the following:
- WordPress website is available under `http://localhost/[awesome_wp_project]`
- WordPress Theme exists
Note: folder naming on different OS can differ.
```bash
cd [awesome_wp_project]/wp-content/themes/[theme_folder_name]
git clone [email protected]:wwwebman/gulp-webpack-starter.git [frontend_folder_name]
cd [frontend_folder_name]
cp .env.wordpress .env
```
### 2. Modify .env
##### Required
Set correct values to `BROWSER_SYNC_TARGET` and `BROWSER_SYNC_PUBLIC_PATH` variables.
- `BROWSER_SYNC_TARGET` - refers to WordPress website installed locally
- `BROWSER_SYNC_PUBLIC_PATH` - refers to the relative pathname of `bundle.js` in the browser.
##### Not required
All compiled files land to `themes/[theme_folder_name_folder]/assets`.
Modify `ROOT_DIST` to change the destination.
### 3. Double check if assets attached in `[theme_folder_name]/functions.php`:
```php
function enqueue_styles()
{
wp_enqueue_style('custom', get_template_directory_uri() . '/assets/css/bundle.css', [], null);
}
add_action('wp_enqueue_scripts', 'enqueue_styles');
function register_scripts()
{
wp_enqueue_script('custom-js', get_template_directory_uri() . '/assets/js/bundle.js', [], null, true);
}
add_action('wp_enqueue_scripts', 'register_scripts');
```
#### 4. Run
```bash
cd [theme_folder_name]/[frontend_folder_name]
yarn
yarn start
```
**This is cool, isn't it?**
If you still have a problem, let us know by opening an [issue](https://github.com/wwwebman/gulp-webpack-starter/issues).
## Commands
```bash
yarn start // Runs development mode
yarn build // Compiles assets in production mode
```
## License
MIT License, Copyright © 2015-present, [Dmytro Chumak](https://webman.pro).
See [LICENSE](./LICENSE) for more information.
