gulp-pug-sass-starter
v1.0.0
Published
Starter kit for Templating frontend using Gulp - Pugjs - Sass
Readme
Gulp-Pug-Sass Starter Project
==============================================================
A professional starter kit for frontend templating using Gulp, Pug, and Sass. This project is optimized for modern development workflows with built-in linting, formatting, and production-ready build processes.
🚀 Features
- Pug & Sass: High-performance templating and styling.
- Live Reloading: BrowserSync for real-time development feedback.
- Production Ready: Optimized builds with minification and sourcemaps.
- Code Quality: Integrated Prettier, ESLint, and Stylelint for consistent code standards.
- Error Handling: Visual notifications via
gulp-notifyto prevent workflow interruptions.
📁 Project Structure
|-- _site/ (Generated production files)
|-- _src/ (Source files)
| |-- _assets/ (Images and other assets)
| |-- _pug/ (Pug templates)
| | |-- parts/ (Reusable Pug components)
| |-- _sass/ (Sass stylesheets)
| | |-- pages/ (Page-specific styles)
| | |-- parts/ (Reusable Sass components)
|-- .gitignore (Version control exclusion)
|-- gulpfile.js (Gulp automation tasks)
|-- package.json (Project dependencies and scripts)🛠️ Getting Started
Prerequisites
Ensure you have Node.js installed on your machine.
Installation
Clone the repository and install the dependencies:
npm install🏃 Running the Project
Development Mode
To start a local development server with live reloading and error notifications:
npm startProduction Build
To generate an optimized, minified version of your site in the _site/ folder:
npm run build:prod🧹 Clean Build Directory
To remove the _site/ folder:
npm run clean📝 Development Standards
This project uses the following tools to maintain code quality:
- Prettier: Automatic code formatting.
- ESLint: JavaScript linting.
- Stylelint: CSS/Sass linting.
To run these tools manually, you can use your IDE's plugins or the command line.
