System Prerequisites

Both the server and the editor ship with a default configuration, that works out of the box with the Dockerfiles we provide.

Operating system

Livingdocs runs under Mac OSX, Linux and Windows 10 (in a linux docker container). For Windows 10 proceed first to setup Windows 10

Prerequisites

In order to setup and run a Livingdocs application on your local machine, you need to make sure that the following programs and libraries are installed and publicly available on your system:

  • Node.js - Probably the world's most used Javascript runtime. Livingdocs is written in Javascript, so this one is definitely a hard requirement. You find installation instructions for all operating systems on their website. To UNIX users, we recommmend using NVM, a Node Version Manager that offers streamlined installation and upgrade procedures as well as version management.

  • Docker - Very broadly, Docker is a tool designed to make it easier to create, deploy, and run applications by using containers. We use it to run our storage services (databases, search index and so on) on your local machine.

  • GraphicsMagick - A library that, among other things, enables image processing. We use it mainly to resize images.

  • Git - Everybody's favorite distributed version control software. We use it extensively and, let's be honest, chances are you are too.

  • jq - A lightweight and flexible command-line JSON processor. We use it for batch patches and data migrations.

On a lower note, you'll also need active Github and Docker accounts respectively.

Get the code

Create a new directory, change to it and clone our boilerplate repositories from Github:

git clone https://github.com/livingdocsIO/livingdocs-server-boilerplate
git clone https://github.com/livingdocsIO/livingdocs-editor-boilerplate

Now, what did you get?

Within livingdocs-server-boilerplate we have a default configuration for a Livingdocs Server instance. This server, once up and running, will take care of a variety of things, from persisting your documents to search indexation – however, it is exclusively data driven or headless.

The second folder livingdocs-editor-boilerplate contains a default configuration for a Livingdocs Editor instance, our editing user interface.

The ENVIRONMENT variable

With this value, we determine under what kind of base premise the services should get run. At this point, we only need to know, that for a local setup we always want that value to be set to local. You can either call the folllowing line before each and every script or permanently set the environment variable by adding the following line to your ~/.zhsrc or ~/.bashrc

export ENVIRONMENT=local

Please note These boilerplates are not meant to be used for anything else than local evaluation. They also include configurations for rate limited third-party API's that we provide for convenience reasons.

To proceed, follow the instructions in each repository's README: