Skip to content
lexevs edited this page Mar 30, 2023 · 5 revisions

Repository:https://github.com/lexevs/lexevs-service-rest-docs

Install CTS2 API Documentation local PC

Note: Have the following installed

  • node.js v16.11.1
  • npm 8.0.0
  • Redis install is NOT required

Clone the repository and cd to it:

  1. git clone https://github.com/cts2/lexevs-service-rest-docs
  2. cd lexevs-service-rest-docs

Install the necessary components (based on the package.json file)

  • npm install

Start the server 2 ways

  • npm start
  • Nohup npm start &

Go to the URL for the docs http://localhost:3000/

Update the port, if needed (restart required) lexevs-service-rest-docs/config.json - Defines port to run on (3000 by default)

Local test install on Dev VM

  1. Install node version manager https://github.com/nvm-sh/nvm
  2. curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
  3. export NVM_DIR="$HOME/.nvm"
  4. [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh" # This loads nvm
  5. [ -s "$NVM_DIR/bash_completion" ] && . "$NVM_DIR/bash_completion" # This loads nvm bash_completion
  6. nvm install 16 // installs node and npm
  7. Node v16.13.2
  8. Npm 8.1.2
  9. Follow the directions above for local PC
Clone this wiki locally