This app can be used as both a static website and a Chrome extension. It generates an index.html and a handful of JavaScript and CSS files for the website and a manifest.json
for the Chrome extension. The extension replaces your browser's "new tab" page with the static website.
First: ensure you have NodeJS installed. Run
node -v
in the terminal to confirm.Globally install
bower
andgrunt
:npm install -g bower grunt-cli
git clone
this repositorynpm install
to install Grunt and its dependenciesbower install
to install the source librariesgrunt
to build and launch the development server
grunt build
: compile sources (Coffee, Sass, templates) fromapp/
todist/
grunt dev
⇒grunt
: compile source and launch a development server that watches changes and reloads the browsergrunt minify
: optimize and obfuscate compiled source files for production (rungrunt build
first)grunt dist
: build and minify source code indist/
, copy production assets, and launch a static production preview servergrunt deploy
: upload production source to the GitHub Page
Generally, you'll run grunt dev
(or simply grunt
for convenience) while you develop. This command launches the development server which watches for changes to source files and recompiles and reloads intelligently.