Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
anselmh committed Dec 13, 2013
0 parents commit f81100e
Show file tree
Hide file tree
Showing 10 changed files with 186 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# editorconfig.org

# top-most EditorConfig file
root = true

[*]
end_of_line = lf
indent_style = tab
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[.htaccess]
indent_style = space
indent_size = 2

[*.json]
indent_style = space
indent_size = 2
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Include your project-specific ignores in this file
# Read about how to use .gitignore: https://help.github.com/articles/ignoring-files

*.sass-cache
*.sublime-*

node_modules
35 changes: 35 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"node": true,
"browser": true,
"esnext": true,
"bitwise": true,
"camelcase": true,
"curly": true,
"eqeqeq": true,
"immed": true,
"latedef": true,
"newcap": true,
"noarg": true,
"undef": true,
"unused": true,
"strict": true,
"trailing": true,
"smarttabs": true,

"globals": {
"jQuery": true,
"$": true,

"module": true,
"require": true,
"requirejs": true,
"define": true,

"sinon": true,
"describe": true,
"it": true,
"expect": true,
"beforeEach": true,
"afterEach": true
}
}
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Changelog

### HEAD

### v0.1.0 (2013-12-13)
* Initial development
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Contributing to INIT

If you got something that's worth including into the project please [submit a Pull Request](https://github.com/use-init/init-htmlmin/issues) or [open an issue](https://github.com/use-init/init-htmlmin/issues) for further discussion.

[@necolas](https://github.com/necolas) [wrote down some good guidelines](https://github.com/necolas/issue-guidelines) for contributing to his projects. Please keep these in mind when contributing to this project. <3

Please use the `.editorconfig`-file in order to set the right usage of tabs/spaces in your editor. Visit [editorconfig.org](http://editorconfig.org/) for more information.
22 changes: 22 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2013 Anselm Hannemann, http://helloanselm.com

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# INIT LiveReload

A plugin for [INIT](http://use-init.com/) using [grunt-contrib-watch](grunt-contrib-watch#optionslivereload) to live reload your changed assets automatically in your browser.

## Dependencies

- Live Reload [Browser extensions](http://feedback.livereload.com/knowledgebase/articles/86242-how-do-i-install-and-use-the-browser-extensions-).

[![devDependency Status](https://david-dm.org/init/init-htmlmin/dev-status.png)](https://david-dm.org/use-init/init-livereload#info=devDependencies)

## Installation
You can add this plugin to INIT by copying over the file `config/watch.js` to `tasks/options` (replace/override the old one).
This enables livereload for CSS, JavaScript and images.

## Usage
You have now live reload enabled when you run the `grunt watch` task. You still need either the browser extensions enabled or insert the following script right before your closing `</body>` tag:

<script src="//localhost:35729/livereload.js"></script>

If you use the livereload app in parallel you'll get an error message that the port is already in use. Quit the app or specify another port in `watch.js`:

livereload: {
options: {
livereload: 1337 // You can set any port number here instead of 'true' which sets it to port '35729'
},
files: [config.sass.devDest, config.js.files, config.img.src]
},

## More…
You can [see all possibilities here](https://github.com/gruntjs/grunt-contrib-watch#live-reloading).

## Contribute
Please help making this project better and [contribute](CONTRIBUTING.md) with your knowledge.

## Development
This package is developed as part of the [INIT project](https://github.com/use-init/).

## License
Please be aware of the licenses of each component we use in this project. Everything else that has been developed by the contributions to this project is under [MIT License](LICENSE.md).
28 changes: 28 additions & 0 deletions config/watch.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/**
* Live Reload your Assets
*/
'use strict';

var config = require('../config');

module.exports = {
scss: {
files: config.sass.files,
tasks: 'sass:dev'
},

js: {
files: config.jsHintFiles,
tasks: ['jshint', 'connect:test', 'karma:unit']
},

karma: {
files: [config.jsHintFiles, config.tests.src],
tasks: ['connect:test', 'karma:unit']
},

livereload: {
options: { livereload: true },
files: [config.sass.devDest, config.js.files, config.img.src]
},
};
22 changes: 22 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"name": "init-livereload",
"title": "INIT LiveReload",
"description": "A plugin for INIT to livereload your assets",
"version": "0.1.0",
"homepage": "https://github.com/use-init/init-livereload",
"repository": {
"type": "git",
"url": "git://github.com/use-init/init-livereload.git"
},
"bugs": {
"url": "https://github.com/use-init/init-livereload/issues"
},
"license": "MIT",
"dependencies": {},
"devDependencies": {
"matchdep": "0.3.0",
"grunt": "0.4.2",
"grunt-contrib-watch": "~0.5.3"
},
"keywords": []
}

0 comments on commit f81100e

Please sign in to comment.