|
1 | | -# A Gulp Task for HTML, Sass/CSS, and JavaScript |
| 1 | +# A Set of Gulp v4.0.0 Tasks for Creating Web Projects Using HTML, CSS/Sass, and JavaScript |
2 | 2 |
|
3 | | -(v3.0.1) |
| 3 | +(v4.0.1) |
4 | 4 |
|
5 | 5 | --- |
6 | 6 |
|
7 | 7 | ## Installation |
8 | | -You need to have Java installed before continuing, as the browser refresh module requires it. Additionally, all the required Node modules need to be installed before you can use this template. From the root folder of this project, type `npm install`. This will create a folder called `node_modules` and download the plugins listed under the `devDependencies` section in the `package.json` file. If you encounter an `ERR!` message about `EACCES`, then you’ll need to run the command as the super user: `sudo npm install`. Because the Gulp tasks amount to about 157MB, expect to wait. |
| 8 | +You need to have Java installed before continuing, as the browser refresh module requires it. Additionally, all the required Node modules need to be installed before you can use this template. From the root folder of this project, type `npm install`. This will create a folder called `node_modules` and download the plugins listed under the `devDependencies` section in the `package.json` file. If you encounter an `ERR!` message about `EACCES`, then you’ll need to run the command as the super user: `sudo npm install`. Because the Gulp tasks amount to about 112MB, expect to wait. |
9 | 9 |
|
10 | 10 | ## Tasks |
11 | | -Typing `gulp --tasks`, or simply `gulp`, will provide you with a list of tasks included in `gulpfile.js`. Tasks such as `build` and `serve` invoke other tasks and are nested in the output of `gulp --tasks`. |
| 11 | +Typing `gulp --tasks`, or simply `gulp`, will provide you with a list of tasks included in `gulpfile.js`. Tasks such as `build` and `serve` invoke other tasks and are nested in the output of `gulp --tasks` and are executed in `<series>`. |
12 | 12 |
|
13 | | -Each task can be run on its own. For example, if all you want to do is validate your HTML, you can type `gulp validateHTML`, and if the task runs to completion without any messages, it means your HTML is valid and W3-compliant. |
14 | | - |
15 | | -Above each task in the `gulpfile.js` file is an elaborate comment discussing what each task does. |
| 13 | +Each task can be run on its own. For example, if all you want to do is validate your HTML, you can type `gulp validateHTML`. |
16 | 14 |
|
17 | 15 | ## Running the Project |
18 | 16 | All your work must be added to the sub-folders under the `dev` folder: your markup in `html`, your Sass/CSS in `styles`, your JavaScript in `scripts`, and your images in `img`. |
19 | 17 |
|
20 | | -For development, run `gulp serve`, which runs multiple development-related tasks, then launches your default browser and listens for changes. Gulp keeps you informed via The Terminal. You can now work on your project as you normally would. Each time you save a file, your browser will refresh so you don’t have to. |
| 18 | +During development, run `gulp serve`, which runs multiple development-related tasks, then launches your default browser and reloads on file changes. |
21 | 19 |
|
22 | 20 | For production-ready projects, run `build`, which creates a folder called `prod`. This is the folder you’d upload to your server if you were going live with your project. |
0 commit comments