-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdocumentation.html
199 lines (155 loc) · 5.95 KB
/
documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<!DOCTYPE html>
<html lang="en">
<head>
<title>Documentation | NoFlo</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./css/bootstrap.min.css" />
<link rel="stylesheet" href="./css/main.css" />
</head>
<body>
<div class="page">
<div class="row-fluid">
<div class="site-header span12">
<div class="container">
<a href="./" class="logo">NoFlo</a>
<nav class="main-nav">
<ul class="nav">
<li><a href="./">Demos</a></li>
<li><a href="./documentation.html">Documentation</a></li>
<li><a href="./library.html">Library</a></li>
</ul>
</nav>
<nav class="util-nav">
<ul class="nav dropdown">
<li>
<a href="./" class="email" data-toggle="dropdown" data-target="#">Email</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="./">
<span class="dropdown__action">Download </span>
<span class="dropdown__tally">104</span>
</a>
</li>
<li>
<a href="./">
<span class="dropdown__action">Star</span>
<span class="dropdown__tally">8201</span>
</a>
</li>
<li>
<a href="./">
<span class="dropdown__action">Fork</span>
<span class="dropdown__tally">321</span>
</a>
</li>
</ul>
</li>
<li>
<a href="./" class="share" data-toggle="dropdown" data-target="#">Share</a>
</li>
<li>
<a href="./" class="github" data-toggle="dropdown" data-target="#">Github</a>
</li>
</ul>
</nav>
</div>
<!-- /.container -->
</div>
<!-- .site-header-->
</div>
<!-- /.row -->
<div class="row-fluid">
<div class="page-title">
<div class="container">
<h1 class="page-title__title">Documentation</h1>
<a href="./" class="btn btn-primary page-title__button download-button">On GitHub</a>
</div>
</div>
<!-- /.page-title -->
</div>
<!-- /.row -->
<div class="row-fluid">
<div class="container">
<div class="main">
<div class="sidebar span4">
<nav>
<ul class="sidebar__nav">
<li><a href="./">Requirements and installing</a></li>
<li><a href="./">Changes</a></li>
<li><a href="./">Using NoFlo</a></li>
<li><a href="./">Running the Examples</a></li>
<li><a href="./">Terminology</a></li>
<li><a href="./">Components</a></li>
<li><a href="./">The NoFlo Shell</a></li>
<li><a href="./">Designing NoFlo graphs with DrawFBP</a></li>
<li><a href="./">The web-based NoFlo monitor</a></li>
<li><a href="./">NoFlo graph file format</a></li>
<li><a href="./">Language for Flow-Based Programming</a></li>
<li><a href="./">Development</a></li>
<li><a href="./">Discussion</a></li>
</ul>
</nav>
</div>
<!-- /.sidebar -->
<div class="content span8">
<h1>NoFlo: Flow-based programming for Node.js</h1>
<h2>Requirements and installing</h3>
<p>NoFlo is available <a href="./">via NPM</a>, so you can install it with:</p>
<pre><code>$ npm install -g noflo</code></pre>
<h3>Installing from Git</h3>
<p>NoFlo requires a reasonably recent version of <a href="./">Node.js</a>, and some
<a href="./">npm</a> packages. Ensure you have the grunt-cli package installed (grunt command should be available on command line) and NoFlo checked out from Git. Build NoFlo with:</p>
<pre><code>$ grunt build</code></pre>
<p>You can also build NoFlo only for the desired target platform with either <em>grunt build:nodejs</em> or <em>grunt build:browser</em>.</p>
<p>Then you can install everything needed by a simple:</p>
<pre><code>$ npm link</code></pre>
<p>NoFlo is available from <a href="./">GitHub</a> under the MIT licence.</p>
<hr />
<h2>Changes</h2>
<p>Please refer to the <a href="./">CHANGES.md document</a>.</p>
<hr />
<h2>Using NoFlo</h2>
<p>There are two ways to use NoFlo:</p>
<ul>
<li><strong>Independent:</strong> Building the whole control logic of your software as a
NoFlo graph, and running it with the noflo tool</li>
<li><strong>Embedded:</strong> Using NoFlo as a library and calling some NoFlo graphs whenever
your software needs workflows</li>
</ul>
<p>When you create a NoFlo graph, it doesn't do anything by itself. It only loads the
components of the graph and sets up the connections between them. Then it is up to
the components to actually start sending messages to their outports, or reacting to
messages they receive on their inports.</p>
<p>Since most components require some input before they act, the usual way to make a NoFlo
graph run is to send it some initial information packets, or IIPs. Examples of this
would include sending a port number that a web server could listen to the web
server component, or sending a file name to a file reader.</p>
<p>This activation model provides many possibilities:</p>
<ul>
<li>Starting the graph based on user interaction (shell command, clicking a button)</li>
<li>Starting the graph based on a received signal (Redis pub/sub, D-Bus signal, WebHook,
email)</li>
<li>Starting the graph at a given time or interval (running a graph on the first of
every month, or five minutes from now)</li>
<li>Starting the graph based on context (when arriving to a physical location, when user
goes to a ...</li>
</ul>
</div>
<!-- /.content -->
</div>
<!-- /.main -->
</div>
<!-- /.container -->
</div>
<!-- /.row -->
</div>
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.1/jquery.min.js"></script>
<script src="./js/min/bootstrap.min.js"></script>
<!--<script src="https://raw.github.com/jkeyes/baseline/master/baseliner/baseliner.js"></script>
<script>
window.onload = function() {
baseliner = new Baseliner(15);
}
</script>-->
</body>
</html>