You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,21 +24,19 @@ See [dist/Dockerfile](https://github.com/ctubio/tribeca/tree/master/dist#dockerf
24
24
25
25
1. Ensure your target machine has node v6 or greater (`nodejs -v`) and mongoDB v3 or greater (`mongo --version`).
26
26
27
-
2.Clone the repository somewhere with `git clone ssh://git@github.com/ctubio/tribeca`.
27
+
2.Run `git clone ssh://git@github.com/ctubio/tribeca` in any location that you wish.
28
28
29
-
3.In the toplevel path of the git cloned repository, `npm install`. This will install all local dependencies in `node_modules` folder and also compile TypeScript in `src` folder to CommonJS in `app` folder.
29
+
3.Copy `etc/tribeca.json.dist` to `etc/tribeca.json` and modify the configuration options, see [configuration](https://github.com/ctubio/tribeca/tree/master/etc#configuration-options) section. Point the instance towards the running mongoDB instance (usually just `mongodb://localhost:27017/tribeca`).
30
30
31
-
4. Copy `etc/tribeca.json.dist` to `etc/tribeca.json`, and modify the config keys, see [configuration](https://github.com/ctubio/tribeca/tree/master/etc#configuration-options) section. Point the instance towards the running mongoDB instance (usually just `mongodb://localhost:27017/tribeca`).
32
-
33
-
5. In the toplevel path of the git cloned repository, `npm start`, or `service tribeca start` anywhere if the optional init script `dist/tribeca-init.sh` is installed.
31
+
4. Run `npm start` in the toplevel path of the git cloned repository. This will install all local dependencies in `node_modules` folder and will compile TypeScript in `src` folder to CommonJS in `app` folder if it was not already done before, then it runs `tribeca.js` in the background using [forever](https://www.npmjs.com/package/forever).
34
32
35
33
Optional:
36
34
37
-
1. Install the system daemon script `dist/tribeca-init.sh`, it requires forever (`npm i -g forever`), see [dist](https://github.com/ctubio/tribeca/tree/master/dist) folder.
35
+
1. Install the system daemon script `dist/tribeca-init.sh` (to make use of `service tribeca start` from anywhere instead of `cd path/to/tribeca && npm start`) see [dist](https://github.com/ctubio/tribeca/tree/master/dist) folder.
38
36
39
37
2. Replace the certificate at `etc/sslcert` folder with your own, see [web ui](https://github.com/ctubio/tribeca#web-ui) section. But, the certificate provided is a fully featured default openssl, that you may just need to authorise in your browser.
40
38
41
-
3. Set environment variable TRIBECA_CONFIG_FILE to full path of `tribeca.json` if you run the app manually from other locations with `nodejs path/to/tribeca.js` or with forever globally installed `forever start path/to/tribeca.js`. The environment variable is not needed if the working directory is the root folder where `tribeca.js` is located.
39
+
3. Set environment variable TRIBECA_CONFIG_FILE to full path of `tribeca.json` if you run the app manually from other locations with `nodejs path/to/tribeca.js`. The environment variable is not needed if the working directory is the root folder where `tribeca.js` is located.
42
40
43
41
### Configuration
44
42
@@ -80,15 +78,21 @@ The metrics send are:
80
78
* Total amount available in wallet and held in open trades in BTC currency
81
79
* Total amount available in wallet and held in open trades in Fiat currency
82
80
83
-
### TEST UNITS
81
+
### Test units and Build notes
84
82
85
83
Feel free to run `npm test` anytime.
86
84
85
+
To rebuild the application with your modifications, please run `npm install` or directly `npm run postinstall`.
86
+
87
+
To piped the output to stdout, execute the application in the foreground with `nodejs tribeca.js`.
88
+
89
+
To save the output in `log/tribeca.log` file, execute the application in the background with `forever start tribeca.js` or with the alias `npm start`.
90
+
87
91
### Unreleased Changelog:
88
92
89
93
Added nodejs6, typescript2 and angular2.
90
94
91
-
Added npm install scripts instead of grunt tasks.
95
+
Added cleanup of global dependencies, source code and installation steps.
0 commit comments