README.md

   1 # Gargantext Haskell
   2
   3 ## About this project
   4
   5 Gargantext is a collaborative web platform for the exploration of sets
   6 of unstructured documents. It combines tools from natural language
   7 processing, text-mining, complex networks analysis and interactive data
   8 visualization to pave the way toward new kinds of interactions with your
   9 digital corpora.
  10
  11 This software is a free software, developed by the CNRS Complex Systems
  12 Institute of Paris Île-de-France (ISC-PIF) and its partners.
  13
  14 ## Installation
  15
  16 ### Front-End
  17
  18 Front-End is written in [Purescript](http://www.purescript.org/).
  19 Then Gargantext Front-End is developed in another git repository.
  20 Before building the whole repo you need:
  21
  22 1. Get the source code:
  23     git clone https://gitlab.iscpif.fr/gargantext/purescript-gargantext.git
  24 2. cd purescript-gargantext
  25 3. read the README.md to install it
  26
  27
  28 ### Back-End
  29
  30 Back-End of Gargantext rely on several backends:
  31 1. Haskell backend with orchestrator
  32 2. Python backend
  33 3. Others backends
  34
  35 Docker will be created to ease the backends installation.
  36
  37 ## Haskell Backend
  38
  39 On Linux Debian (and Ubuntu?), install Dependencies.
  40 sudo apt-get install libbz2-dev lipq-dev
  41 (In the near future, we will use Nix.)
  42
  43 ### Database: install, configure and populate
  44
  45 1. Postgresql installation
  46 ``shell
  47 sudo apt update && sudo apt install postgresql-9.6
  48 sudo su postgres
  49 psql
  50 ``
  51
  52 2. Configuration
  53
  54 first create your local database:
  55 ``sql
  56 create role gargantua with password "see gargantext.ini";
  57 create database gargandb with owner gargantua;
  58 ``
  59
  60 3. Populate
  61
  62 second get a dump/schema of the database:
  63 md5sum gargandb.gz == 2c97ea9cfb67cd9767b779632a71e19f  gargandb.gz
  64
  65 third insert the database in gargandb
  66 ``shell
  67 gunzip gargandb.zip
  68 psql gargandb < gargandb
  69 ``
  70
  71
  72 ### Install Stack
  73 - https://docs.haskellstack.org/en/stable/README/
  74 - curl -sSL https://get.haskellstack.org/ | sh
  75
  76 ### Get the orchestrator library
  77
  78 git clone https://github.com/np/servant-job.git
  79
  80 ### Get the clustering louvain library
  81
  82 git clone https://gitlab.iscpif.fr/gargantext/clustering-louvain.git
  83
  84 ## Building and installing
  85 stack install
  86
  87 ## Run Gargantext
  88 ~/.local/bin/gargantext --run Mock --port 8008