View Source

Instructions for installing LexEVS 6.x CTS2 Documentation API Service.

The installation directory can be anywhere.

The name of the install directory will be "cts2Docs".

The path to the install directory will be referred to as "<path to install dir>"

Step-by-step installation guide

Create an install directory called <path to install dir>/cts2Docs
Go into the install directory

Clone git repository
1. git clone https://github.com/cts2/lexevs-service-rest-docs.git
2. This will create a project under <path to install dir>/cts2Docs/lexevs-service-rest-docs

Download Node.js (linux 64 bit) (v0.10.35) to <path to install dir>/cts2Docs
1. File download location: nodejs.org/dist/v0.10.35/node-v0.10.35-linux-x64.tar.gz
Unzip the file node-v0.10.35-linux-x64.tar.gz
1. tar -vxzf node-v0.10.35-linux-x64.tar.gz
Add an environment variable for NPM
1. export NPM_HOME=<path to install dir>/cts2Docs/node-v0.10.35-linux-x64
2. export PATH=${PATH}:$NPM_HOME/bin
Update the port that node.js runs on (OPTIONAL step)
1. <path to install dir>/cts2Docs/lexevs-service-rest-docs/config.json
2. the "port" parameter is set to 3000 by default. It can be changed as needed. This port used by the end URL to get to the CTS2 API Documentation: (http://server_name:port)

Download Redis version 2.8.19 to <path to install dir>/cts2Docs
1. File download location: https://github.com/antirez/redis/archive/2.8.19.tar.gz
Unzip the file redis-2.8.19.tar.gz
1. tar -vxzf redis-2.8.19.tar.gz
Build redis
1. cd <path to install dir>/cts2Docs/redis-2.8.19
2. make

Start the redis server
1. nohup <path to install dir>/cts2Docs/redis-2.8.19/src/redis-server &
2. By default, redis is running on port 6379
Start the Node.js server
1. nohup <path to install dir>/cts2Docs/lexevs-service-rest-docs
2. nohup npm start &
3. node.js is set to run on port 3000 by default.

You may also want to use visual panels to communicate related information, tips or things users need to be aware of.