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 ### Install Stack
  44 - https://docs.haskellstack.org/en/stable/README/
  45 - curl -sSL https://get.haskellstack.org/ | sh
  46
  47 ### Get the orchestrator library
  48
  49 git clone https://github.com/np/servant-job.git
  50
  51 ### Get the clustering louvain library
  52
  53 git clone https://gitlab.iscpif.fr/gargantext/clustering-louvain.git
  54
  55 ## Building and installing
  56 stack install
  57
  58 ## Run Gargantext
  59 ~/.local/bin/gargantext --run Mock --port 8008