5
5
## Automated installation with HedgehogBundle (recommended)
6
6
7
7
HedgehogBundle allows a very simple installation of the Hedgehog platform, the IDE can be installed via a single command.
8
- After cloning or downloading the bundle to the controller, simple enter the following two commands in the ` HedgehogBundle ` directory:
8
+ After cloning or downloading the bundle to the controller, simply enter the following two commands in the ` HedgehogBundle ` directory:
9
9
10
10
``` bash
11
11
$ cd ide
@@ -18,25 +18,38 @@ Now you are all set! The IDE should be running on port 80 of your controller and
18
18
## Manual installation (only for advanced users)
19
19
20
20
In order to install the Hedgehog IDE manually on the Hedgehog controller, you first need to install Node.JS.
21
- To do so, open a terminal connection to your Hedgehog's Raspberry Pi, and type the following.
21
+ To do so, open a terminal connection to your Hedgehog's Raspberry Pi.
22
+ We recommend NVM for installing a node version:
23
+
24
+ ``` bash
25
+ $ sudo aptitude -y install libssl-dev libzmq-dev libcurl4-gnutls-dev
26
+ $ curl -L https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
27
+
28
+ $ export NVM_DIR=" $HOME /.nvm"
29
+ $ . " $NVM_DIR /nvm.sh"
30
+ $ nvm install 8.14.0
31
+ ```
32
+
33
+ Alternatively, download and install a distribution manually:
22
34
23
35
``` bash
24
- $ wget https://nodejs.org/dist/v8.9.4/node-v8.9.4-linux-armv6l.tar.xz
25
- $ tar -xvf node-v8.9.4-linux-armv6l.tar.xz
26
- $ sudo cp -R node-v8.9.4-linux-armv6l/* /usr/local/
27
36
$ sudo apt install libssl-dev libzmq-dev libcurl4-gnutls-dev
37
+ $ wget https://nodejs.org/dist/v8.14.0/node-v8.14.0-linux-armv6l.tar.xz
38
+ $ tar -xvf node-v8.14.0-linux-armv6l.tar.xz
39
+ $ sudo cp -R node-v8.14.0-linux-armv6l/* /usr/local/
28
40
```
29
41
30
42
Now you have the following options:
31
43
- install an official release of the Hedgehog IDE
32
- - build the IDE from source for development
33
- - build the IDE from source and make your own production version
44
+ - run the IDE in development mode
45
+ - build the IDE from source and run it
46
+ - build the IDE from source and prepare a release
34
47
35
48
In each case, you will need to apply the correct configuration and set the ` environment ` option correctly.
36
49
37
50
### Installing a release
38
51
39
- Simply download the latest release to your controller:
52
+ Simply download and unpack the latest release to your controller:
40
53
41
54
``` bash
42
55
$ wget https://github.com/PRIArobotics/hedgehog-ide/releases/download/v1.3.0/hedgehog-ide-1.3.0-linux-armv7l.tar.gz
@@ -58,22 +71,34 @@ $ npm install
58
71
### development mode
59
72
60
73
If you plan to work on the IDE itself and test changes frequently, this is what you want.
61
- The command will start a server and apply updates to any files automatically
74
+ The command will start a server and apply updates to any files automatically.
62
75
63
76
``` bash
64
77
$ npm run develop
65
78
```
66
79
67
80
Your configuration needs to use ` environment: 'debug', ` .
68
81
69
- ### production mode
82
+ ### building the IDE
83
+
84
+ With these commands, you build the IDE once and can then run it again multiple times.
85
+ Changes to the source files will not affect the IDE until you rebuild.
86
+
87
+ ``` bash
88
+ $ npm run build
89
+ $ npm run start
90
+ ```
91
+
92
+ Your configuration needs to use ` environment: 'production', ` .
93
+
94
+ ### preparing a release
70
95
71
- If you want to build an optimized production build of the IDE, this is the right way.
72
- The commands here will first build a Hedgehog IDE release, and then start the webserver.
96
+ To release a new version of the IDE, use these commands.
97
+ Compared to ` build ` , ` release ` will apply some pruning to reduce size,
98
+ and collect all files into the ` release/ ` directory for packaging.
73
99
74
100
``` bash
75
101
$ npm run release
76
- $ npm start
77
102
```
78
103
79
104
Your configuration needs to use ` environment: 'production', ` .
0 commit comments