create-myhtmlproject v0.2.2
Create HTML5 Boilerplate
Quick start for HTML5 Boilerplate. Get up and running with one command.
Getting Started
You can get started using one of three options- npx
, npm init
, or
yarn create
Using npx
npx create-create-myhtmlproject new-site
cd new-site
npm install
npm start
Using npm init
npm init create-myhtmlproject new-site
cd new-site
npm install
npm start
Using yarn
yarn create create-myhtmlproject new-site
cd new-site
yarn install
yarn start
These commands are equivalent and do the following:
- Download and install the latest version of HTML5 Boilerplate
- Installs dependencies
- Bundles site assets and start a web server using Parcel
- Opens a web browser pointed to http://localhost:1234/
Requirements
create-create-myhtmlproject
is cross-platform. It works wherever node and npm work.
The only requirements are for npx
, which requires npm version 5.2 or greater and
npm init
which requires an npm version greater than 6.0. If you're stuck on an
older version of npm you can still use create-create-myhtmlproject
by running the
following command to install the project globally.
npm install -g create-create-myhtmlproject
Then you can use create-create-myhtmlproject
as in the following example
create-create-myhtmlproject new-site
cd new-site
npm install
npm start
Installing Specific Versions
You can also install a specific version:
npx create-create-myhtmlproject new-site --release=7.2.0
cd new-site
npm install
npm start
CONTRIBUTING
Setting Up a Local Copy
- Clone the repo with
git clone https://github.com/h5bp/create-create-myhtmlproject.git
- Run
npm install
in the rootcreate-create-myhtmlproject
folder. - Run
npm link
to make npm run local copy instead of downloading from registry - Now you can use
npm init create-myhtmlproject
andnpx create-create-myhtmlproject
note: you can use npx create-create-myhtmlproject ./out/example
from create-create-myhtmlproject
without running npm link
also its possible to run directly NodeJS entry point node index.js ./out/example
or npm 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-create-myhtmlproject ./out/new-site
cd new-site
npm install
npm start
Tests
Tests are written using jest and located in tests/test.js
run npm test
run coverage reports npm run coverage