Add binary file

Author: evanhuang8

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Evan Huang
+Copyright (c) 2015 Epharmix <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ 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.
-

README.md

@@ -1,3 +1,109 @@
-### Toureiro
+# Toureiro
 
-========
+A graphical monitoring interface for the distributed job queue [bull](https://github.com/OptimalBits/bull) built using `express` and `react`. Toureiro provides simple monitoring features as well as the ability to promote delayed jobs directly.
+
+## Screenshots
+
+## Get Started
+
+First install `toureiro` from `npm`.
+
+```
+npm install toureiro
+```
+
+You can then use `toureiro` in your project. The constructor `toureiro()` will return an `express` app, which you can then have it listen to any port you desire:
+
+```javascript
+var toureiro = require('toureiro');
+var app = toureiro();
+var server = app.listen(3000, function() {
+  console.log('Toureiro is now listening at port 3000...');
+});
+```
+
+Or you can mount it to a subpath for your own `express` server:
+
+```javascript
+var express = require('express');
+var toureiro = require('toureiro');
+
+var app = express();
+/**
+ * Your own setup...
+ */
+app.use('/toureiro', toureiro());
+
+var server = app.listen(8080);
+```
+
+You can also run `toureiro` as a standalone program:
+
+```bash
+> toureiro
+Toureiro is now listening at port 3000...
+```
+
+## Config
+
+By default, `toureiro` will try to connect to the redis db #0 at 127.0.0.1:6379, but you can configure it yourself:
+
+```javascript
+var app = toureiro({
+  // Options to be passed directly to redis.createClient(),
+  // see https://github.com/NodeRedis/node_redis#rediscreateclient
+  redis: {
+    // Redis host
+    host: '127.0.0.1',
+    // Port
+    port: 6379
+    // DB number
+    db: 1
+    // Other redis options...
+  }
+});
+```
+
+## Usage
+
+```
+
+```
+
+## Why Bull?
+
+Distributed task queue is a necessity in a lot of use cases. Among all the queues out there, [Celery](http://www.celeryproject.org/) is probably the most prominent and has the biggest community. However, it's hard to integrate `Celery` into the Node.js programs, simply because that's another language environment to maintain. Therefore, a javascript native task queue is much needed.
+
+Among the queues written for `javascript`, [Kue](https://github.com/Automattic/kue.git) is the most widely used one. `Kue` is a great library, and we have relied heavily on `Kue` before, but we are gradually troubled by the various bugs of the library. Due to the time when `Kue` was first written, a lot of things weren't possible (for example, atomicity of complex `redis` operations, which is now enabled by the built-in `LUA` scripting engine). What's more, several important features (FIFO behavior of delayed jobs, for instance) are missing from `Kue` or are hard to implement due to the early design decisions.
+
+Then `bull` came along. It's written by the guys from OptimalBits and its APIs are modeled heavily after those of `Kue`. In its core, however, it's written very carefully (and differently from `Kue`) to ensure robustness and atomicity. Bugs that are common to distributed queue designs are not found with `bull` or have been fixed along the way.
+
+As awesome as `bull` is, the only thing that is missing is a web monitoring interface, much like that of `Kue`, so we decided to make our own, thus `toureiro` is born.
+
+## Browser Compatibility
+
+It's compatible with all modern browsers. Since the front end relies on `react`, and `react` does support all the way down to IE8, it's possible that IE8 will work as well, though with messy styles.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Epharmix <[email protected]>
+
+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.

bin/toureiro.js

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+var minimist = require('minimist');
+var toureiro = require('../lib/toureiro');
+
+var argv = minimist(process.argv.slice(2));
+
+if (argv.h || argv.help) {
+  console.log('Usage: toureiro [port]');
+  console.log('[port]         Port for toureiro to listen to');
+  console.log('Options:');
+  console.log('--rh           Redis host, default to 127.0.0.1');
+  console.log('--rp           Redis port, default to 6379');
+  console.log('--rdb          Redis database number, default to 0');
+  console.log('--pass         Redis password, default to null');
+  process.exit(0);
+}
+
+var port = 3000;
+if (argv._.length > 0 && !isNaN(parseInt(argv._[0]))) {
+  port = parseInt(argv._[0]);
+}
+var redisHost = '127.0.0.1';
+if (argv.rh) {
+  redisHost = argv.rh;
+}
+var redisPort = 6379;
+if (argv.rp && !isNaN(parseInt(argv.rp))) {
+  redisPort = argv.rp;
+}
+var redisDB = 0;
+if (argv.rdb && !isNaN(parseInt(argv.rdb))) {
+  redisDB = argv.rdb;
+}
+var redisPass = null;
+if (argv.pass) {
+  redisPass = argv.pass;
+}
+
+var app = toureiro({
+  redis: {
+    host: redisHost,
+    port: redisPort,
+    auth_pass: redisPass,
+    db: redisDB
+  }
+});
+var server = app.listen(port, function() {
+  console.log('Toureiro is now listening at port', port, '...');
+});

lib/toureiro.js

@@ -30,8 +30,6 @@ module.exports = function(config) {
     res.sendStatus(404);
   });
 
-  var server = app.listen(config.port || 3000, function() {
-    console.log('Toureiro is now listening at port', server.address().port, '...');
-  });
+  return app;
 
-};
+};

package.json

@@ -35,6 +35,7 @@
     "jade": "1.11.x",
     "jquery": "2.1.x",
     "lodash": "3.10.x",
+    "minimist": "1.2.x",
     "moment-timezone": "0.4.x",
     "react": "0.13.x",
     "redis": "2.1.x"
@@ -56,5 +57,8 @@
     "vinyl-buffer": "1.0.x",
     "vinyl-source-stream": "1.1.x",
     "watchify": "3.4.x"
+  },
+  "bin": {
+    "toureiro": "./bin/toureiro.js"
   }
 }

server.js

@@ -1,5 +1,8 @@
-require('./lib/toureiro')({
+var app = require('./lib/toureiro')({
   redis: {
     db: 1
   }
-});
+});
+var server = app.listen(3000, function() {
+  console.log('Toureiro is now listening at port 3000...');
+});