Pugle Web Starter is an opinionated boilerplate for web development. It includes tools for responsive design and performance-oriented development. It tries to follow best practices outlined in Google's Web Fundamentals and to be documented enough so that everyone, regardless of their current training with used tools, could use it (and perhaps learn with it).
| Feature | Summary |
|---|---|
| Pug templates | Build your HTML files with ease using Pug, with access to global info through the app/siteinfo.js file (as siteinfo) and specific page info through a index.json file (for a index.pug sibling file) (as page) within the Pug template. |
| Sitemap Generation | Sitemap generation for html files, prefering extension-less urls, using the date of last modification in a commit of a pug file as last modification date for the generated html file. Be sure to commit on each file significant changes! |
| Sass support with autoprefixing | Compile Sass into CSS with ease, bringing support for variables, mixins and more. Process into CSS and autoprefix the rules. |
| Text-files optimization | Minify and concatenate JavaScript, CSS and HTML files. Serve unprocessed files by placing them in the app/root directory (to be copied "as it" into dist. |
| Image optimization | Support for PNG, WEBP, JPG, GIF and SVG formats. |
| Responsive images | Generate different sizes and webp versions of images to provide responsiveness. Follows app/config/responsive.config.js configuration file. |
| Mobile meta tags for favicons | Generation (and injection) of mobile meta tags for icons, favicons, tile icons, manifest files, etc. Follows app/config/favicon.config.js configuration file. |
| Open graph and Twitter tags | "Hardcoded" template in Pug base file. Fill in each page's json companion with corresponding info to fill them correctly. |
| Google analytics | Just modify 'UA-XXXXX-X' in [app/templates/google-analytics.js](the snippet) for your own code (provided by Google) and it'll be injected into every HTML (thanks to pug base file). |
| Code Linting | JavaScript code linting is done using ESLint - a pluggable linter tool for identifying and reporting on patterns in JavaScript. Web Starter Kit uses ESLint with eslint-config-google, which tries to follow the Google JavaScript style guide. |
| ES2015 (ES6) via Babel 6.0 | ES2015 support using Babel. To disable ES2015 support add the "only": "gulpfile.babel.js", option in the package.json file (Babel's section). ES2015 source code will be automatically transpiled to ES5 for wide browser support. |
| Sourcemaps for JS and CSS | For easier debugging, sourcemaps pointing to the original lines in pre-processed CSS and JS files are generated. |
| Built-in HTTP Server | A built-in server for previewing your site locally while you develop and iterate |
| Cross-device Synchronization | Synchronize clicks, scrolls, forms and live-reload across multiple devices as you edit your project. Powered by BrowserSync. |
| Live Browser Reloading | Reload the browser in real-time anytime an edit is made without the need for an extension. (Run gulp serve and edit your files) |
| Offline support (Service Worker ready) | Thanks to Google's newly baked Service Worker's tool Workbox, sites deploying dist to a HTTPS domain will enjoy offline support. |
| PageSpeed Insights | Web performance metrics showing how well your site performs on mobile and desktop (Run gulp pagespeed) |
Download the kit or clone this repository and build on what is included in the app directory.
Be sure to check all files and read through the comments to understand a bit the building process.
Pugle Web Starter is based upon Google's outdated Web Starter Kit, which "strives to give you a high performance starting point out of the box. [Their] median Web Page Test scores for the default template have a Speed Index of ~1100 (1000 is ideal) and a repeat-visit Speed Index of ~550 thanks to Service Worker precaching." As this kit uses improved Service Worker tools, minifiers and image compressors, we're confident in that it reaches at least the stated speed. We're yet to check on that and post our own tests, though.
Regarding CSS and JS support, we aim to support ät least the last two versions of the following browsers, including their respective iOS and Android versions.
- Chrome
- Firefox
- Safari
- Opera
- Edge
- Internet Explorer 9+
The kit can be used for developing for older browsers, but it might need some customization (or careful planning) to make it work seemlessly.
If you find yourself running into issues during installation or running the tools, please open an issue. We would be happy to discuss how they can be solved.
Contributions, questions and comments are all welcome and encouraged. For code contributions to Pugle Web Starter, please see our Contribution guide before submitting a pull request.
Apache 2.0
Web Starter Kit is an opinionated boilerplate for web development. Tools for building a great experience across many devices and performance oriented. Helping you to stay productive following the best practices outlined in Google's Web Fundamentals. A solid starting point for both professionals and newcomers to the industry.
| Feature | Summary |
|---|---|
| Responsive boilerplate | A responsive boilerplate optimized for the multi-screen web. Powered by Material Design Lite. You're free to use either this or a completely clean-slate via basic.html. |
| Sass support | Compile Sass into CSS with ease, bringing support for variables, mixins and more. (Run gulp serve or gulp for production) |
| Performance optimization | Minify and concatenate JavaScript, CSS, HTML and images to help keep your pages lean. (Run gulp to create an optimised version of your project to /dist) |
| Code Linting | JavaScript code linting is done using ESLint - a pluggable linter tool for identifying and reporting on patterns in JavaScript. Web Starter Kit uses ESLint with eslint-config-google, which tries to follow the Google JavaScript style guide. |
| ES2015 via Babel 6.0 | Optional ES2015 support using Babel. To enable ES2015 support remove the line "only": "gulpfile.babel.js", in the .babelrc file. ES2015 source code will be automatically transpiled to ES5 for wide browser support. |
| Built-in HTTP Server | A built-in server for previewing your site locally while you develop and iterate |
| Live Browser Reloading | Reload the browser in real-time anytime an edit is made without the need for an extension. (Run gulp serve and edit your files) |
| Cross-device Synchronization | Synchronize clicks, scrolls, forms and live-reload across multiple devices as you edit your project. Powered by BrowserSync. (Run gulp serve and open up the IP provided on other devices on your network) |
| Offline support | Thanks to our baked in Service Worker pre-caching, sites deploying dist to a HTTPS domain will enjoy offline support. This is made possible by sw-precache. |
| PageSpeed Insights | Web performance metrics showing how well your site performs on mobile and desktop (Run gulp pagespeed) |
Download the kit or clone this repository and build on what is included in the app directory.
There are two HTML starting points, from which you can choose:
index.html- the default starting point, containing Material Design layout.basic.html- no layout, but still includes our minimal mobile best-practices
Be sure to look over the installation docs to verify your environment is prepared to run WSK. Once you have verified that your system can run WSK, check out the commands available to get started.
Web Starter Kit strives to give you a high performance starting point out of the box. Our median Web Page Test scores for the default template have a Speed Index of ~1100 (1000 is ideal) and a repeat-visit Speed Index of ~550 thanks to Service Worker precaching.
At present, we officially aim to support the last two versions of the following browsers:
- Chrome
- Edge
- Firefox
- Safari
- Opera
- Internet Explorer 9+
This is not to say that Web Starter Kit cannot be used in browsers older than those reflected, but merely that our focus will be on ensuring our layouts work great in the above.
If you find yourself running into issues during installation or running the tools, please check our Troubleshooting guide and then open an issue. We would be happy to discuss how they can be solved.
If you would prefer not to use any of our tooling, delete the following files from the project: package.json, gulpfile.babel.js and .travis.yml. You can now safely use the boilerplate with an alternative build-system or no build-system at all if you choose.
- File Appendix - What do the different files here do?
- Using Material Design Lite's Sass - how to get MDL's Sass working with WSK
- Deployment guides - available for Firebase, Google App Engine and other services.
- Gulp recipes - the official Gulp recipes directory includes a comprehensive list of guides for different workflows you can add to your project.
Web Starter Kit is inspired by Mobile HTML5 Boilerplate and Yeoman's generator-gulp-webapp, having taken input from contributors to both projects during development. Our FAQs attempt to answer commonly asked questions about the project.
Contributions, questions and comments are all welcome and encouraged. For code contributions to Web Starter Kit, please see our Contribution guide before submitting a pull request. Website related issues should be filed on the Web Fundamentals issue tracker.
Apache 2.0
Copyright 2015 Google Inc