Skip to content

Latest commit

 

History

History
135 lines (79 loc) · 3.85 KB

getting-started.md

File metadata and controls

135 lines (79 loc) · 3.85 KB
status author editor spellChecked
published
masterbunny@gmail.com
j.faassen@linkorb.com
2018-07-17

Getting started

Prerequisites for Installing NetworQ

The following prerequisites must be met before undertaking the installation:

  1. You are familiar with using Git

  2. You are familiar with editing YAML

  3. You are able to run (minimum version 7) PHP applications on your machine

  4. You are able to run Composer NB further system-dependent instructions for installing composer are available here

If one or more of these conditions are not met, don't worry. Rather, check out the demo installation instead!

Install

Two items are required:

  • "NetworQ Web" is our web-based viewer application. You can configure it to load a Graph of your choice and browse it.

  • "NetworQ Cli" is a command-line utility used to:

    • inspect graphs (list packages, types, nodes)
    • install package dependencies

1. Install NetworQ Web

To install, use a command prompt to run:

$ git clone https://github.com/networq/networq-web
$ cd networq-web # move to the directory
$ composer install # Install this project's dependencies
$ cp .env.dist .env # Copy the included `.env.dist` file to `.env`

2. Install NetworQ Cli

Next, install the command-line utilities + package manager. Choose a suitable directory location and use a command prompt to run:

$ git clone https://github.com/networq/networq-cli
$ cd networq-cli
$ composer install

Apply a Package

A NetworQ package must exist. For this example, we will use the Holacracy Package.

1. Clone the package

Clone the package from Git using a command window directed at the folder location you want to store the clone in:

$ git clone https://github.com/networq/holacracy-nqp

2. Install NetworQ

Install NetworQ to run this package.

Change directory of the command window, to the folder containing your package, in this example the holacracy-nqp and run networq install.

The installation will create a directory "packages" and import all the dependency packages for your Graph.

3. Configure NetworQ

The directory networq-web contains an environment file. Configure the NETWORQ_GRAPH variable in the .env file to apply any valid NetworQ package.

The environmental settings may be adjusted using the command prompt:

$ edit .env # Adjust for your setup
  • Define the settings via the command prompt:
NETWORQ_GRAPH=/path/to/holacracy-nqp
NETWORQ_EXAMPLES=true
  • Or edit the file directly. Browse to the file:

edit .env

  • Set the value of NETWORQ_GRAPH to the folder containing the package.
  • Set the NETWORQ_EXAMPLES to true.
  • Save and close the file.

edit .env

Setting NETWORQ_EXAMPLES=true loads any example nodes found in the examples/ directory of the root package.

4. Start the server

  • Using a command prompt pointed at the directory networq-web run the server using:
$ php -S 0.0.0.0:8080 -t public/

Quick start with example data

Congratulations! You should now be able to browse the example nodes in the holacracy package.

example nodes

Next Steps

A good next step is to take an abstract overview of the components involved.

To work with the data structure and learn more about the different components continue with this Holacracy example.

Or, create your own graph using existing packages.