| 1 | Ripple WebRTC Socket Server
|
| 2 | =========
|
| 3 |
|
| 4 | This directory contains the code base for the Ripple WebRTC Socket Server, which is a separately packaged NodeJS project
|
| 5 | that runs alongside the Ripple UI (Org-Ripple-UI) and Ripple Java Middleware (Org-Ripple-Middleware).
|
| 6 |
|
| 7 |
|
| 8 | ### Requirements
|
| 9 |
|
| 10 | To develop and run the application locally you must have the following installed:
|
| 11 | * NodeJS >= v6.2.0
|
| 12 | * A running version of the Ripple UI
|
| 13 | * A running version of the Ripple Middleware
|
| 14 | * Two users, both of whom are connected to separate networks, logged in as a patient and clinician
|
| 15 |
|
| 16 |
|
| 17 | ### Installation
|
| 18 |
|
| 19 | 1. Open a shell and navigate to the socket-server directory
|
| 20 | 2. Run 'npm install'
|
| 21 | 2. Run 'node socket'
|
| 22 |
|
| 23 |
|
| 24 | ### Optional Installation
|
| 25 |
|
| 26 | 1. Install pm2, which is a NodeJS daemon which can run the socket server in the background, by running 'npm install -g pm2'
|
| 27 | 2. Run the socket server in the background by running 'pm2 start pm2.json'
|
| 28 | 3. Save the pm2 daemon configuration by running 'pm2 save'
|
| 29 |
|
| 30 | ### Configuration
|
| 31 |
|
| 32 | The database connection details (MySQL) located in the socket-server/lib/db.js file. Feel free to change these credentials
|
| 33 | according to your database configuration and schema.
|