Skip to content
This repository has been archived by the owner on Jan 17, 2023. It is now read-only.

Form5/grunt-seed

Repository files navigation

grunt-seed v0.1.0 Build Status Dependency Status Built with Grunt

This is our badass and customized front-end development workflow that uses Grunt for task automation. This is a project seed that you can use to build your own projects on.

Features

  • Development web server
  • Live reload on file changes
  • Jade for templates
  • ScSS for stylesheets
  • Uses Require.js for asynchronous module loading
  • Install bower dependencies with grunt bower and packages will be automatically placed in the correct directories (will also run on build)
  • JSHint with grunt. See options in .jshintrc
  • Minifies jpg, png, gif, svg, css, html and uglifies javascript
  • Optional deployment via shell command in package.json (`grunt deploy)
  • Desktop notifications on Grunt errors (support varies):

ScreenShot

Setup

$ git init your-project-name
$ cd your-project-name
$ git pull https://github.com/Form5/grunt-seed.git
$ npm install

Development webserver (builds to ./dev)

$ grunt server

Production build (builds to ./dist, with minification etc)

$ grunt build

Structure

src
├── css
│   ├── main.scss
│   └── vendor
├── fonts
├── img
├── js
│   ├── main.js
│   └── vendor
└── views
    ├── index.jade
    └── shared
        ├── _head.jade
        └── layout.jade

Todos and bugs

  • Library of very common code snippets? (Generators perhaps?)
  • Unit tests

See our issue tracker for a complete list of todos, bug reports and milestones.

Author

Form5 is a small interactive studio based in Reykjavík, Iceland. We design and build websites and apps. To learn more about us, check out www.Form5.is.

Contributors

Ólafur Örn Nielsen (@olafurnielsen)

Benedikt Valdez D. Stefánsson (@benediktvaldez)

Árni Reynir Óskarsson (@arnireynir)

Ragnar Þór Valgeirsson (@rthor)