Generator-gulp-smacss-boilerplate NPM

gulp-smacss-boilerplate

npm

This is a boilerplate of the structure that I'm currently using in my projects when choosing the SMACSS architecture, this will be uploaded over time.

This project was possible thanks to Coder Coder with her video Generate website starter files with just one command!. If you'd like to check his boilerplate generator check this out.

Installation

First, You'll need to install the Yeoman dependency globally by using the npm install -g yo command.

    npm install -g yo

Then, you should install this boilerplate globally by using the npm install -g generator-gulp-smacss-boilerplate command.

    npm install -g generator-gulp-smacss-boilerplate

And, as the last step, you have to go to the directory where you'd like to download this boilerplate and then use the yo gulp-smacss-boilerplate command.

    yo gulp-smacss-boilerplate

In case that the package has been updated you can bring the new version to your machine by running the npm update -g generator-gulp-smacss-boilerplate command.
```
    npm update -g generator-gulp-smacss-boilerplate
```

You also will need to install Gulp CLI in your machine if it's your case that you don't have it already by running the npm install -g gulp-cli command.
```
    npm install -g gulp-cli
```
Once the boilerplate is generated, you'll have to run the gulp command every time you want to see your changes processed.
- When running this command, Gulp will open a local server to see your changes in real-time.

Disclaimer: I'm starting to learn how to use Git/Github correctly, therefore there'll be plenty of pull requests, commits and other stuff as tests in this repository, however, this won't represent my way of working forever, I'll learn more things along the way as always :D!.

npm.io

Note: this boilerplate is automatically generated just by typing a command in the CL thanks to Yeoman.

To understand this boilerplate at all you'll need to have a slight notion about Git, Gulp.js, HTML5, CSS3, Javascript, SASS, Netlify.

What's Yeoman?

npm.io

Yeoman is an open source client-side scaffolding tool for web applications. Yeoman runs as a command-line interface written for Node.js and combines several functions into one place, such as generating a starter template, managing dependencies, running unit tests, providing a local development server, and optimizing production code for deployment.

Guide

Note: It's important to remember to update the submodules used to import vendors when starting using this boilerplate.

General

Don't worry about the unnecessary files that are added when updating the vendors such as the README.md file of lessier or the directory with the same name that's dedicated to saving the images needed for the README.md because this boilerplate already counts with those directories added to the .gitignore file, therefore they won't be reflected when pushing commits to upstream.
The boilerplate includes the src and public directories already created because the gulp command was tested before uploading this boilerplate (that's the reason why there's an image and an icon in the assets directory just to see how the final result would be), but you can remove the public directory and the example assets that are in the src directory if you want, and then run the gulp command once you've put your own assets in the src directory to generate a new public directory.
- In theory, it's totally unnecessary to leave the example assets in the uploaded version because their only use-case is for testing the generator before publishing it, but the problem is that Npm ignores empty directories, therefore I considered it better to leave those files there to avoid problems with empty folders.
The project includes a README boilerplate for the final version that will be pushed to the Git repository. This boilerplate includes:
- Disclaimer (this is personal, you can remove it if it's not your case that you're learning Git/Github).
- Table of contents linked to all the headings in the README.
- What I learned section to include everything you learned while creating that project.
- Preview section to include the screenshot of your project as a preview of it.
- Reports section to include the results of the reports (as screenshots) of services like Lighthouse or GTmetrix.
- Open-graph section to include the Open-graph cards of both Twitter and Facebook (you can remove it if it's the case that you didn't include the Open-graph tags in you project).
Both, the public and the src directories will be included when pushing changes to upstream, but the public can be removed if you want just by adding the directory to the .gitignore file.
Disclaimer: be careful when removing the public directory from upstream, keep in mind that if you're hosting your files in Git itself, then, the optimized version of your project won't be visible for Netlify (or whatever deployment platform you're using) in case you have your site synchronized with the git repository of your project (otherwise you can just drop all the files and everything will be visible), therefore keep an eye on the absolute paths you're using in your files to avoid errors when loading the assets.

SMACSS

If you'd like to know more about what's each SASS directory about, you can check these articles for more information:

Note: the versions shown in those articles may vary from mine and it's ok, at the end of the day a project structure is different depending on the project needs and differs from person to person, from team to team, and even from companies to companies, therefore this is my own interpretation of a pattern that already exists, but feel free of modifying it if it's necessary.

Icons

Remember to use Iconifier to create all the icon-size versions of an image.
All the images obtained with Iconifier must be put in the icons directory to work well with the Gulp images tasks.

Netlify

There's a basic Netlify config file to help you when deploying the project altogether with Netlify and Github.
- The base directory is where Netlify will build the site from (if it's necessary). This directory is where's located all the Gulp tasks and package.json files.
- The commands are basically those needed to build the site as I mentioned before.
- The publish directory is where Netlify will put everything that was built with the commands mentioned above.

If you don't know anything about what I've mentioned before, I encourage you to leave the file as it's by default, it'll work just perfectly with the current project structure. In case you won't use Netlify to deploy the site you can remove it without problems.

Gulp tasks

The plugins used by default are the following:

Note: if you'd like to know more about what each plugin does you can click the links that send you to the npm package and then read the descriptions for more information.
Note: remember that if you'd like to change the folders' names you'll have also to change them in the Gulp tasks paths that could be related to that directory.

The task located in the scripts.js file have only 1 source, if you'd like to add more files or complete directories... feel free to do it!, just add new strings with the path to the file/directory of your preference (remember to add a comma after each string).
In the tasks designated to the images optimization, the convertWebp and convertAvif already have the quality option set to 75, if you'd like to change that you can modify the qualityImages variable (the value must be a number between 1 and 100).
- As an alternative, you can remove the imagesQuality variable and add an independent value to each config object located in the tasks but there's not much sense on don't preserve consistency in images quality.
Important: PurgeCSS is automatically connected with all the HTML files to help you avoid adding styles to elements or classes/ids that don't really exist, therefore if you write styles for an element that it's not included in any of your HTML files, those styles won't be included in the public version once they're processed by Gulp.
- But, what happens when you're trying to inject a class/id from Javascript? In those cases you'll need to add those classes manually to an invisible helper element (that's already in the index file to give you a hand), that way PurgeCSS won't exclude the styles from the final result.
- Due to everything mentioned before, the normalized file isn't totally compiled to the final result at the beginning, but everything should be included once you've finished your project and executed the Gulp tasks one more time.