Skip to content

Commit df8c2c2

Browse files
Update Readme.md file
Update the information to install the node in local node-red installation as well as on global projects.
1 parent 48f479a commit df8c2c2

File tree

1 file changed

+58
-3
lines changed

1 file changed

+58
-3
lines changed

README.md

Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,58 @@
1-
# treeViewPackage
2-
Custom treeView strcture of data saved into cloudantDb for Dri-list application.
3-
1+
# Tree view node
2+
---
3+
4+
## Table of Contents
5+
* [What a node is ?](#before_you_begin)
6+
* [Installation](#init_application)
7+
* [ChangeLog](#change_log)
8+
* [Copyrights](#copyrights)
9+
10+
11+
<a name="before_you_begin"></a>
12+
## What a node is ?
13+
---
14+
Nodes get created when a flow is deployed, they may send and receive some messages whilst the flow is running and they get deleted when the next flow is deployed.
15+
16+
They consist of a pair of files; a JavaScript file that defines what the node does, and an html file that defines the node’s properties, edit dialog and help text.
17+
18+
When packaged as an npm module, a package.json file is used to pull it all together.
19+
20+
<a name="init_application"></a>
21+
## Installation
22+
---
23+
###### Installation in local node-red
24+
Go to project root directory and run the following command.
25+
26+
sudo npm link
27+
> (if node is not install as root user the no need to use sudo before command.)
28+
29+
Go to home directory and move ".node-red" installtion directory and run the again same command above i.e.
30+
31+
sudo npm link
32+
> (if node is not install as root user no need to use sudo before command.)
33+
34+
The above both 2 command will create a "symbolik link" between your node-red dashboard code and the actual node project which you were deveolping for node-red.
35+
Each time when you make any new changes in you node project code, you just need to restart you node-red server and will get the updated output in node-red dashboard.
36+
37+
###### Installation on live node-red
38+
To use the node globally in any of you live project you need to publish it on npm globally after that can easily install it inside the node-red via using the following command i.e.
39+
40+
npm install "node_name" --save
41+
42+
To publish code on npm globally you need to following the following link:-
43+
44+
###### Publishing to npm
45+
>There are lots of guides to publishing a package to the npm repository. A basic overview is available [here](https://docs.npmjs.com/misc/developers)
46+
47+
<a name="change_log"></a>
48+
## Change log
49+
---
50+
##### 0.0.1
51+
* Initial release
52+
53+
54+
<a name="copyrights"></a>
55+
## Copyrights
56+
Copyright 2017 Roger Colburn.
57+
58+
You may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)