nutcracker-web 0.0.5 → 0.0.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +22 -22
- data/lib/nutcracker/web/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 723ec8b5104701fa2f47687fabd61114734ab753
|
|
4
|
+
data.tar.gz: a85a1c952d17522f2e49340be25c1ebf73ac971d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 30e738099ce6fe771cd36b7ee862b569c30102c95e532768892377a2611c219fcd5ab242b4c1a13ba1f551be9a01fe6acf59c9248ff8b99eb5fab8a3cbbf0bce
|
|
7
|
+
data.tar.gz: 3d304c975786b6f1a055d6d770327c2d29155222aa45b9df6a8b2150d6fe08f7783a90bbef2cdc165a16a390e5d58bd3e4289dcc8a091eae01f2a6ed38857892
|
data/README.md
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
Nutcracker Web
|
|
1
|
+
Nutcracker Web <a href="https://rubygems.org/gems/nutcracker-web"><img src=https://fury-badge.herokuapp.com/rb/nutcracker-web.png></a>
|
|
2
2
|
=============
|
|
3
3
|
|
|
4
|
-
[
|
|
5
|
-
|
|
4
|
+
Web interface plugin for [nutcracker-ruby](https://github.com/kontera-technologies/nutcracker)<br/>
|
|
5
|
+
|
|
6
6
|
|
|
7
7
|
<img src="https://github.com/kontera-technologies/nutcracker-web/raw/master/pics/pic3.png"/></br>
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
this project is still in its early stages so things could be a little buggy, if you find one feel free to [
|
|
9
|
+
## Disclaimer
|
|
10
|
+
this project is still in its early stages so things could be a little bit buggy, if you find one feel free to report it @ our issue [tracker](https://github.com/kontera-technologies/nutcracker-web/issues).<br/>
|
|
11
11
|
Also nutcracker-web only supports Redis instances for now.
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
## Dependencies
|
|
14
14
|
- Ruby 1.9+
|
|
15
15
|
- [nutcracker-ruby](https://github.com/kontera-technologies/nutcracker)
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
add this to your Gemfile
|
|
17
|
+
## Installation
|
|
18
|
+
with `bundler` just add this line to your `Gemfile` and then execute `bundle install`
|
|
19
19
|
```
|
|
20
20
|
gem 'nutcracker-web'
|
|
21
21
|
```
|
|
22
|
-
|
|
23
|
-
And then execute:
|
|
22
|
+
else you can manually install it by running
|
|
24
23
|
```
|
|
25
|
-
|
|
24
|
+
gem install nutcracker-web
|
|
26
25
|
```
|
|
27
26
|
|
|
28
|
-
|
|
27
|
+
## Usage
|
|
28
|
+
After starting the nutcracker service via [nutcracker-ruby](https://github.com/kontera-technologies/nutcracker) just activate the `nutcracker-web` plugin:
|
|
29
29
|
```ruby
|
|
30
30
|
require 'nutcracker'
|
|
31
31
|
require 'nutcracker/web'
|
|
@@ -40,9 +40,9 @@ nutcracker.use(:web, Port: 1234)
|
|
|
40
40
|
nutcracker.join
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
you can pass default [Rack](https://github.com/rack/rack) [options](https://github.com/rack/rack/blob/master/lib/rack/server.rb#L187..L199) to `Nutcracker#use` ( like :Host, :server etc)
|
|
43
|
+
> you can pass default [Rack](https://github.com/rack/rack) [options](https://github.com/rack/rack/blob/master/lib/rack/server.rb#L187..L199) to `Nutcracker#use` ( like :Host, :server etc)
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
## Custom Webserver
|
|
46
46
|
to use a different webserver like [thin](http://code.macournoyer.com/thin/)
|
|
47
47
|
|
|
48
48
|
```ruby
|
|
@@ -55,27 +55,27 @@ nutcracker.use(:web, Port: 1234, server: :thin)
|
|
|
55
55
|
nutcracker.join
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
## Gotchas
|
|
59
59
|
- `redis.conf` : don't forget to configure the `maxmemory` attribute for each Redis instance
|
|
60
60
|
|
|
61
|
-
|
|
61
|
+
## Developer ?
|
|
62
62
|
to run nutcracker-web with stub data
|
|
63
63
|
- `bundle install`
|
|
64
64
|
- run the `rackup` command to start the service.
|
|
65
65
|
- edit `example.json`.
|
|
66
66
|
- client Backbone app is under `assets` and the Sinatra backend is under the `lib` directory.
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
## Packaging & Testing
|
|
69
69
|
- `rake compile` : compile the assets into a single application.{js,css} file under the public directory
|
|
70
70
|
- `rake build` : compile the assets & builds a new gem
|
|
71
71
|
- `rake test` : runs the jasmine tests suite
|
|
72
72
|
|
|
73
|
-
|
|
74
|
-
This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.
|
|
75
|
-
|
|
76
|
-
### More PNGs
|
|
73
|
+
## More PNGs
|
|
77
74
|
<img src="https://github.com/kontera-technologies/nutcracker-web/raw/master/pics/pic1.png"/></br>
|
|
78
75
|
<hr>
|
|
79
76
|
<img src="https://github.com/kontera-technologies/nutcracker-web/raw/master/pics/pic2.png"/></br>
|
|
80
77
|
<hr>
|
|
81
|
-
<img src="https://github.com/kontera-technologies/nutcracker-web/raw/master/pics/pic4.png"/></br>
|
|
78
|
+
<img src="https://github.com/kontera-technologies/nutcracker-web/raw/master/pics/pic4.png"/></br>
|
|
79
|
+
|
|
80
|
+
## Warranty
|
|
81
|
+
This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: nutcracker-web
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.6
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Eran Barak Levi
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2013-
|
|
11
|
+
date: 2013-11-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: minitest
|