Node.js example

Introduction

To integrate ONLYOFFICE Document Builder into your own application on Node.js you need to download and install ONLYOFFICE Document Builder to your computer and use the Node.js example for the integration. We will show how to run the Node.js example on Window OS and on Linux OS.

Running the example on Windows OS

Step 1. Download and install ONLYOFFICE Document Builder

First, download ONLYOFFICE Document Builder and install it to your computer:

Get ONLYOFFICE Document Builder

Step 2. Download the Node.js code for the editors integration

Download the Node.js Example from our site.

You need to connnect the ONLYOFFICE Document Builder to your web site. For that specify the path in the config/default.json file:

{
  "builderPath": "C:\\ONLYOFFICE\\DocumentBuilder\\docbuilder.exe"
}

Step 3. System requirements

Download and install the node.js enviroment which is going to be used to run the Node.js project. Please follow the link at the oficial website: https://nodejs.org/en/download/, choosing the correct version for your Windows OS (32-bit or 64-bit).

Step 4. Running the Node.js code

We will run the code in Node.js runtime environment and will interact with it using the command line interface (cmd).

1. Launch the Command Prompt and switch to the folder with the Node.js project code, for example:

   cd /d C:\nodejs
   

2. Node.js comes with a package manager, node package manager (npm), which is automatically installed along with Node.js. To run the Node.js code install the project modules using the following npm command:

   npm install
   

   A new node_modules folder will be created in the project folder.

3. Run the project using the Command Prompt:

   node bin/www
   

4. See the result in your browser using the address:

   http://localhost:3000
   

Running the example on Linux OS

Step 1. Download and install ONLYOFFICE Document Builder

First, download ONLYOFFICE Document Builder and install it to your computer.

Step 2. Install the prerequisites and run the application

1. Install Node.js:

   curl -sL https\://deb.nodesource.com/setup\_4.x | sudo bash -
   

   apt-get install nodejs
   

2. Create the Node.js Example project folder. Download the archive with the Node.js Example and unpack the archive in the created folder:

   wget https\://github.com/ONLYOFFICE/document-builder-integration/releases/latest/download/Node.js.Example.zip
   

   unzip Node.js.Example.zip
   

3. Change the current directory for the project directory:

   cd \~/Node.js\ Example/
   

4. Install the dependencies:

   npm install
   

5. Edit the config/default.json configuration file. Specify the path to the ONLYOFFICE Document Builder.

   nano config/default.json
   

   Edit the following lines:

   {
     "builderPath": "/usr/bin/docbuilder"
   }
   

6. Run the project with Node.js:

   nodejs bin/www
   

7. See the result in your browser using the address:

   http://localhost
   

Now you will be able to see the result in your browser using the http://localhost address or using the computer address in your local network.