Harp Boilerplate

A minimal, clean and simple boilerplate based on Harp, npm as a task runner, and deploy to Github Pages.

---

Setup

• git clone this repo
• npm install
• Open up package.json and change any needed configuration in config or scripts

Run

• npm start will open a browser on http://localhost:3000 (BrowserSync)
• All your .jade, .scss, .md files are being watched and magically served (Harp + BrowserSync)

Build

• npm build will create a dist folder with all your static files.
• It will also create a CNAME file for you.

Deploy

• npm gh-deploy will take your dist and push it to your repo's gh-pages branch (git-directory-deploy)
• It will only take update files
• username.github.io/repo and YOUR_DOMAIN are magically updated

Versioning

• You can do semantic versioning with npm (see reference)
• npm version patch, npm version minor, npm version major
• It will also make a git commit for you

---

TODO

• Add some more config options
• Create a Yeoman Generator for this

---

Dependencies

• NodeJS
• bash/zsh/fish

Tools

• HarpJS
• BrowserSync
• git-directory-deploy
• npm

Reference

• Start a Blog with Harp
• Harp, Gulp and BrowserSync
• How to Use npm as a Build Tool (AMAZING)
• Task Automation with npm run

To the creators of these tools, articles and all the people sharing their knowledge - I want to say thank you!

---

License

MIT