Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 2.29 KB

running-the-server.md

File metadata and controls

59 lines (36 loc) · 2.29 KB

Hosting the Intel API Server

Using the prebuilt binaries (recommended)

Prebuilt binaries can be found on the releases page of the Intel API Server repository. Please download the appropriate binary to your server and run it.

On Windows, you can run the binary by double clicking on it.

On Linux/MacOS, you may need to mark the file as an binary. Do this by opening the command prompt and typing:

chmod +x /path/to/file

Then run the file by simply double-clicking on it, or by typing the path to it in terminal.

Using the latest source

To run the server using the latest source code from github, you require git, nodejs and yarn installed.

Git

git must be installed to pull the latest source code.

  • To check if git is already installed, type git --version in terminal/command prompt. You should see a version number displayed after running this command.
  • Here are the official instructions to install git for all platforms in case you haven't installed it already.

NodeJS and Yarn

nodejs and yarn must be installed to run the server locally.

  • To check if NodeJS and Yarn already installed, type node --version && yarn --version in terminal/command prompt. You should see two version numbers displayed after running this command. For developing Dabbu Intel API Server, we use the latest version of Typescript, which compiles to CommonJS code.
  • Here are the official instructions to install NodeJS and Yarn for all platforms in case you haven't installed it already.

Once git, nodejs and yarn are installed, clone the repository using the following command:

git clone https://github.com/dabbu-knowledge-platform/intel-api-server.git

Then make sure you are on the develop branch:

git checkout develop

Next, start the server:

yarn start:prod

This will start the server on a random port if the PORT environment variable is null. To set the port on which the server is running, run the following:

env PORT=<port number> yarn start:prod

This should start the server on the specified <port number>.