README
Generator Mobile
A mobile-first generator based on Web Starter Kit.
In addition to what Web Starter Kit already provides, this generator creates
a deploy
task.
Getting started
You will need NodeJS, npm and yeoman installed.
- Install this generator with
npm install -g yeoman/generator-mobile
. - Run
yo mobile
and answer a few questions about the site you want to build. - The latest release will be fetched from Web Starker Kit repo and adjusted accordingly to your answers.
- Build the site as usual using the instructions on the WSK repo skipping the download step.
- If you've chosen a deployment option, run
gulp deploy
to publish the site.
Hosting and Deployment options
There are 3 hosting categories currently supported by the generator: static hosting, PaaS providers and regular servers.
Here's a list of implementation status for each category.
Static hosting
PaaS
Servers
Deployment options (servers only)
Please, refer to the docs folder for details about hosting and deployment.
Development
Fork the repo and create a local copy with
git clone git@github.com:user/generator-mobile.git
.Create a new branch to work on a bugfix or a new feature with
git checkout -b branch-name
.Add new tests or modify existing ones to reflect the changes you want to make.
Make the changes until
npm test
is all green again.Occasionally push changes to github with
git push origin branch-name
.Iterate over 3-5 as many times as you want.
You can also try running the generator with your local changes manually using npm link.
Once you're satisfied, create a pull request.
License
BSD license Copyright (c) Google