Permalink
Browse files

Add submodules for alertify and bootstrap, checkout tags, use grunt

  • Loading branch information...
bitpshr committed Mar 13, 2013
1 parent 1b91f70 commit a256619fc4634a3981fe84fd47daa12e5aaeb58d
View
@@ -0,0 +1,6 @@
+[submodule "vendor/bootstrap"]
+ path = vendor/bootstrap
+ url = https://github.com/twitter/bootstrap.git
+[submodule "vendor/alertify"]
+ path = vendor/alertify
+ url = https://github.com/fabien-d/alertify.js.git
View
@@ -0,0 +1,32 @@
+/*global module:false*/
+module.exports = function(grunt) {
+
+ // Project configuration.
+ grunt.initConfig({
+ pkg: grunt.file.readJSON('package.json'),
+ jshint: {
+ files: ['src/*.js', 'bin/*.js']
+ },
+ concat: {
+ dist: {
+ src: ['vendor/alertify/lib/alertify.js', 'src/holler-client.js'],
+ dest: 'dist/<%= pkg.name %>-client.concat.js'
+ }
+ },
+ uglify: {
+ build: {
+ src: '<%= concat.dist.dest %>',
+ dest: 'dist/<%= pkg.name %>-client.min.js'
+ }
+ }
+ });
+
+ // Load the plugin that provides the "uglify" task.
+ grunt.loadNpmTasks('grunt-contrib-uglify');
+ grunt.loadNpmTasks('grunt-contrib-jshint');
+ grunt.loadNpmTasks('grunt-contrib-concat');
+
+ // Default task(s).
+ grunt.registerTask('default', ['jshint', 'concat', 'uglify']);
+
+};
View
@@ -67,12 +67,20 @@ You can also redirect the current page to a new url. Again, all users using the
holler http://yourServerUrl:port redirect http://someOtherUrl
```
-##Going forward
-I definitely need to address the following:
-
-* Security: need a way to lock down notifications so that only auth'd users can send them
-* Simplicity: need a way to simplify the holler.js command (it's ugly to pass in 3 options)
-
+##Contributing
+Holler.js uses [Grunt](http://gruntjs.com) for file linting and uglification. To start contributing, first make sure [node](http://nodejs.org) is installed. Then:
+
+```bash
+git clone https://github.com/bitpshr/holler.git && cd holler
+git submodules update --recursive --init
+cd vendor/bootstrap && npm install && make bootstrap && cd ..
+npm install
+# start a server at localhost (e.g. http://127.0.0.1)
+holler-server
+# view demo.html in a browser
+# send a log message
+holler http://127.0.0.1:1337 log "foobar"
+```
##License
[WTFPL](http://sam.zoy.org/wtfpl/)
View

Some generated files are not rendered by default. Learn more.

Oops, something went wrong.
Oops, something went wrong.

0 comments on commit a256619

Please sign in to comment.