Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/infolis/infolis-web

The InFoLiS web application
https://github.com/infolis/infolis-web

Last synced: about 1 month ago
JSON representation

The InFoLiS web application

Awesome Lists containing this project

README 

        
# infolis-web

Infolis Web services



* [REST API](#rest-api)

* [Simple HTTP API](#simple-http-api)

	* [`/simple/links`](#simplelinks)

		* [Parameters](#parameters)

			* [`identifier`](#identifier)

			* [`name`](#name)

			* [`tags`](#tags)

* [`/simple/datasets`](#simpledatasets)

* [Deployment](#deployment)

	* [TL;DR](#tl-dr)

	* [Step 1: Set up your Working environment for InFoLiS-Web](#step-1-set-up-your-working-environment-for-infolis-web)

		* [Git](#git)

		* [cURL](#curl)

		* [Nodesource](#nodesource)

		* [NodeJS](#nodejs)

		* [Raptor2 Utilites](#raptor2-utilites)

		* [MongoDB](#mongodb)

		* [npm](#npm)

	* [Step 2: Clone the infolis project repositories](#step-2-clone-the-infolis-project-repositories)

	* [Step 3: Get the project running](#step-3-get-the-project-running)

		* [Infolis.github.io](#infolisgithubio)

		* [Infolis-web](#infolis-web)



This software is licensed under the [MIT license](./LICENSE) terms.



## REST API



Try out the [Infolis API UI](https://infolis.gesis.org/api).



The REST API is defined by the [Infolis TSON](./data/infolis.tson).



## Simple HTTP API



This is a simplified API for simple clients, producing simple results

using simple mechanics, simply encoded.



### `/simple/links`



Find links between entities (publications, datasets, databases...).



#### Parameters



##### `from_id`

##### `to_id`



Search from/to this [`identifiers`](http://infolis.gesis.org/infolink/api/tson#identifiers)



## Deployment



infolis-web should run on any BSD/Linux system supporting NodeJS and MongoDB. However

we run our deployment on an Ubuntu 14.04 LTS Server system and assume deployment

on a Debian/Ubuntu system in the following.



### TL;DR



To install the requirements for a Ubuntu 14.04 LTS system, as root:



```

wget -qO- https://deb.nodesource.com/gpgkey/nodesource.gpg.key | apt-key add -

echo 'deb https://deb.nodesource.com/4.0 trusty main' > /etc/apt/sources.list.d/nodesource.list

echo 'deb-src https://deb.nodesource.com/4.0 trusty main' >> /etc/apt/sources.list.d/nodesource.list

apt-get update

apt-get install curl git nodejs raptor2-utils mongodb jekyll

git clone https://github.com/infolis/infolis-web

git clone https://github.com/infolis/infolis.github.io

```



To start the infolis-web service:



```

npm start

```



To start the infolis.github.io site locally



```

npm jekyll

```



### Step 1: Set up your Working environment for InFoLiS-Web



To run and work infolis-web properly, you first have to fulfill the

requirements by setting up a working environment on your system as described

below:



Install Git, cURL, Nodesource, NodeJS, Raptor2 Utilities and MongoDB (in this

order)



#### Git



In order to receive your local copy of infolis web services later, you have to

install git.  Open your shell and type



`sudo apt-get install git`



#### cURL



cURL (CURL URL Request Library) is an open source library and command line tool

for transferring data using various protocols. If cURL is not installed while

working on InFoLiS web services, you will get a screen full of errors and an

empty ~/.shcolor.sh file.



Open your shell and type



`sudo apt-get install curl`



#### Nodesource



Install the Nodesource repository as described

[here](https://github.com/nodesource/distributions#manual-installation):



Open your shell and type



```

curl -s https://deb.nodesource.com/gpgkey/nodesource.gpg.key | apt-key add -

echo 'deb https://deb.nodesource.com/{VERSION} {DISTRO} main' > /etc/apt/sources.list.d/nodesource.list

echo 'deb-src https://deb.nodesource.com/{VERSION} {DISTRO} main' >> /etc/apt/sources.list.d/nodesource.list

```



Replace "VERSION" with the version of NodeJS you want to install (e.g. `4.0`) and "DISTRO" with the name of

your distribution (e.g. `trusty`).



We recommend to use a NodeJS version from after the io.js-reunification, i.e. >= 4.0.



To find your distro name, check the `/etc/*-release` file, e.g.



```

cat /etc/*-release

> [...]

> DISTRIB_CODENAME=vivid

> [...]

```



After receiving Nodesource, type



`sudo apt-get update`



#### NodeJS



Node.js is a JaVaScript runtime designed to build scalable network applications.



Open your shell and type



`sudo apt-get install nodejs`



Be sure that you have NodeJS Version 4.0.0 or later. You can look up your version by typing

`nodejs --version`



#### Raptor2 Utilites



Raptor 2 RDF parser and serializer utilities provides the rapper tool for validation, parsing and serializing RDF syntaxes.



Open your shell and type



`sudo apt-get install raptor2-utils`



#### MongoDB

MongoDB is an open source database.



Open your shell and type



`sudo-apt get install mongodb`



#### npm

npm is a package manager for JavaScript. You will need it to run the services.



Open your shell and type



`npm install --verbose`



### Step 2: Clone the infolis project repositories



Login to your GitHub Account and fork the following repositories:



[Infolis.github.io](https://github.com/infolis/infolis.github.io)



[Infolis-web](https://github.com/infolis/infolis-web)



Make new directories for both repositories and clone them to receive your local copy.



`git clone [email protected]:yourgithub/infolis.github.io`



`git clone [email protected]:yourgithub/infolis-web`



### Step 3: Get the project running



Host the Services on your local server. You can serve `infolis.github.io` via Jekyll and `infolis-web` via npm.



#### Infolis.github.io

`Infolis.github.io` contains the landing page for the project and additional information.



cd to your `infolis.github.io` directory and type



`jekyll serve`



Open your browser. `infolis.github.io` will be available under `localhost:4000`.



#### Infolis-web

Infolis-web contains all the web services of InFoLiS.



cd to your `infolis-web` directory and type



`npm run start`



to host the web services under `localhost:3000/`.



The following services are available:



* API Explorer: `localhost:3000/api`

* Raptor Graph Serialisation (Infolink Schema): `localhost:3000/schema`

* Linked Data Fragments: `localhost:3000/api/ldf`

* Monitor: `http://localhost:3000/api/monitor`

* Datastore stats: `localhost:3000/api/stats`