web-starter-kit README

The project's README from github.com/google/web-starter-kit. As one markdown file: README.md.

Web Starter Kit

Overview

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.

Features

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)

Quickstart

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:

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 Performance

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.

Browser Support

At present, we officially aim to support the last two versions of the following browsers:

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.

Troubleshooting

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.

A Boilerplate-only Option

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.

Docs and Recipes

Inspiration

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.

Contributing

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.

License

Apache 2.0
Copyright 2015 Google Inc

web-starter-kit (google/web-starter-kit)

Searching Database…

18.3K ·GitHub
Web-starter-kit
archived
Что это такое?Web Starter Kit от Google — это готовый шаблон со встроенным рабочим процессом на Gulp для создания сайтов, которые хорошо работают на любых устройствах, в соответствии с лучшими практиками из Google Web Fundamentals. Он подойдёт и профессионалам, и новичкам.
Так это фреймворк, на котором я строю сайт, или инструмент, который я запускаю?Ни то, ни другое — это стартовый шаблон: адаптивная заготовка с инструментами сборки на Gulp вокруг неё. Разметка основана на Material Design Lite, а в комплекте есть и вариант с чистого листа.
Как начать делать на нём сайт?Скачайте или склонируйте репозиторий и работайте в папке app, выбрав index.html (разметка Material Design) или basic.html (чистый лист). Затем запустите gulp serve, чтобы смотреть сайт локально с автоматическим обновлением в браузере.
Что должно быть установлено, чтобы всё заработало?Node.js и Gulp — в README есть ссылки на инструкции по установке, чтобы проверить своё окружение, а в метаданных пакета требуется Node 0.12 или новее.
Проект ещё активно поддерживается?Нет — репозиторий на GitHub заархивирован и работает только на чтение, так что обновлений больше не будет. Как отправная точка или справочник он вполне хорош, но развиваться не будет.
Какие браузеры будет поддерживать мой готовый сайт?Набор официально поддерживает две последние версии Chrome, Edge, Firefox, Safari, Opera, а также Internet Explorer 9+; более старые браузеры в фокусе не стоят.
Что мне на самом деле даёт рабочий процесс на Gulp?gulp serve поднимает встроенный HTTP-сервер с живым обновлением в браузере и синхронизацией между устройствами через BrowserSync (клики, прокрутки и формы повторяются на всех устройствах); gulp собирает оптимизированную папку /dist со сжатыми и объединёнными JS, CSS, HTML и картинками, а gulp pagespeed показывает метрики производительности для мобильных и настольных устройств.
Чем отличаются index.html и basic.html?index.html — отправная точка по умолчанию с разметкой Material Design; в basic.html разметки нет, но минимальные лучшие практики для мобильных устройств там всё равно заложены.
Мой сайт будет работать офлайн прямо из коробки?Да, но с одним условием: встроенное предварительное кэширование через Service Worker (на базе sw-precache) заработает, если вы развернёте собранную папку dist на домене с HTTPS.
Можно обойтись без инструментов сборки и оставить только шаблон?Да — просто удалите package.json, gulpfile.babel.js и .travis.yml, и заготовку можно использовать с любой другой системой сборки или вообще без неё.
What are similar projects?Skeleton, material-design-lite, material-components-web, mdb-ui-kit, material, simplefolio, open-saas, LearnCS8-Resume
Which topics is it in?sass, boilerplate, responsive, material-design, google, offline, beginner-friendly, css, html, web-development, performance, frontend
Creator
google
Size
9.9 MB
Stars
18.3K
Updated
CommitJan 09Releasev0.6.5Dec 13
Age
12y
Commits · 90 Days