README.md
A modern NPM/Gulp web starter kit for projects
Web Starter Kit is an opinionated boilerplate for web development. Tools for building a great experience across many devices. A solid starting point for both professionals and newcomers to the industry.
| Feature | Summary |
|---|---|
| Easy start | We don't use responsive boilerplate. You are free to make your own decision in what way to make responsive for the site. Just start with index.html. |
| Sass support | Compile Sass into CSS with ease, bringing support for variables, mixins and more. (Run gulp for project compiling) |
| 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 /assets) |
| Code Hinting | JavaScript code hinting is done using JsHint - a hinter tool for identifying and reporting on patterns in JavaScript. |
| ES2015(ES6) Support | Optional ES2015 support .You can use all kind of ES6 features here. 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 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 and open up the IP provided on other devices on your network) |
Download the kit or clone this repository and build on what is included in the assets directory.
You can start from index.html - the default starting point, with template text.
Be sure to look over the installation docs to verify your environment is prepared to run Web Starter Kit. Once you have verified that your system can run WSK, check out the commands available to get started.
At present, we officially aim to support the last two versions of the following browsers:
- Chrome
- Edge
- Firefox
- Safari
- Internet Explorer 11+
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. You can now safely use the boilerplate with an alternative build-system or no build-system at all if you choose.
- Commands - Main commands of the WSK.
- Using Sass - how to get Sass working with WSK
- Install build - how to install build.
- Project structure - basic structure of project build.
- JS guides - Guide for using JavaScript in build.
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.
The MIT License (MIT)
Copyright (c) 2017 JustCoded