Repository files navigation

Quick start for HTML5 Boilerplate. Get up and running with one command.

You can get started using one of three options-npx,npm init, oryarn createUsingnpx

npx create-html5-boilerplate new-sitecd new-sitenpm installnpm start

Usingnpm init

npm init html5-boilerplate new-sitecd new-sitenpm installnpm start

Using yarn

yarn create html5-boilerplate new-sitecd new-siteyarn installyarn start

These commands are equivalent and do the following:

1. Download and install the latest version of HTML5 Boilerplate
2. Installs dependencies
3. Bundles site assets and start a web server usingParcel
4. Opens a web browser pointed tohttp://localhost:1234/

create-html5-boilerplate is cross-platform. It works wherever node and npm work.The only requirements are fornpx, which requires npm version 5.2 or greater andnpm init which requires an npm version greater than 6.0. If you're stuck on anolder version of npm you can still usecreate-html5-boilerplate by running thefollowing command to install the project globally.

npm install -g create-html5-boilerplate

Then you can usecreate-html5-boilerplate as in the following example

create-html5-boilerplate new-sitecd new-sitenpm installnpm start

You can also install a specific version:

npx create-html5-boilerplate new-site --release=7.2.0cd new-sitenpm installnpm start

1. Clone the repo withgit clone https://github.com/h5bp/create-html5-boilerplate.git
2. Runnpm install in the rootcreate-html5-boilerplate folder.
3. Runnpm link to make npm run local copy instead of downloading from registry
4. Now you can usenpm init html5-boilerplate andnpx create-html5-boilerplate

note: you can usenpx create-html5-boilerplate ./out/example fromcreate-html5-boilerplate without runningnpm linkalso its possible to run directly NodeJS entry pointnode index.js ./out/example ornpm start./out is git ignored folder, so you should use this folder for tests.

If you want to try out the end-to-end flow with the global CLI, you can do this too:

npx create-html5-boilerplate ./out/new-sitecd new-sitenpm installnpm start

Tests are written usingjest and located intests/test.jsrunnpm test

run coverage reportsnpm run coverage