Skip to content

Latest commit

 

History

History
106 lines (71 loc) · 3.64 KB

README.md

File metadata and controls

106 lines (71 loc) · 3.64 KB
Raw

 

Gargantext with Purescript (FrontEnd instance)

Purescript  Nix  NPM  Yarn  React  HTML  CSS  Bootstrap  Sass  Python  Docker

Table of Contents

  1. About the project
  2. Getting set up
  3. Develoment

About the project

GarganText is a collaborative web-decentralized-based macro-service platform for the exploration of unstructured texts. It combines tools from natural language processing, text-data-mining tricks, complex networks analysis algorithms and interactive data visualization tools to pave the way toward new kinds of interactions with your digital corpora.

This software is free software, developed and offered by the CNRS Complex Systems Institute of Paris Île-de-France (ISC-PIF) and its partners.

GarganText Project: this repo builds the frontend for the backend server built by backend.

Getting set up

Prerequisite: clone the project.

There are two approaches to working with the build:

  1. Use Nix setup (recommended)
  2. Use Docker setup

1. Use Nix setup (recommended)

First install Nix:

sh <(curl -L https://nixos.org/nix/install) --daemon

Verify the installation is complete (Note: close the current terminal session and open en new session to get nix working)

$ nix-env --version
nix-env (Nix) 2.11.0

To build the frontend just execute the install script at the root at the project:

./install

Local instance is ready! (Example: http://localhost:8000/)

2. Use Docker setup

You will need docker and docker-compose installed.

First, Source our environment file:

source ./env.sh

WARNING: you must source ./env.sh before using the docker container. If you don't do that, the container will write files as root and you'll need root powers to get ownership back!

Now build the docker image:

docker compose build frontend

That's it, skip ahead to "Development".

Development

Server

Just serve dist/index.html with any server and you are ready to be connected to any backend.

For instance you can serve it:

cd dist/ && python3 -mhttp.server

Frontend compilation

To see Purescript updates, we have to rebuild:

nix-shell --run build

To compile CSS (Sass):

nix-shell --run "yarn css"