Skip to content
This repository has been archived by the owner on Nov 14, 2022. It is now read-only.
/ highlighter-backend Public archive

text processing components for highlighting and comparing lengthy legal texts

License

Notifications You must be signed in to change notification settings

fhstp/highlighter-backend

Repository files navigation

Warning This project is no longer actively maintained. You can still (re)use it under its MIT license but be aware that the underlying npm packages are outdated and might pose security risks.

HighLighter Backend

Buying a product or signing up for a service implicates a contract between the consumer and the merchant or provider. The average web user is often worried about the possible consequences from such a contract. They are worried in particular when they interact with a new web shop or when the general terms and conditions are updated. However, each contract involves a multitude of legal text that is hard to read and understand.

ContractVis HighLighter provides sophisticated text visualization support for online shopping, yet targets non-professional users in a casual context without training.

ContractVis HighLighter consists of three components:

License: MIT

Tags: node.js, TypeScript, and Visual Studio Code

Installation

Server Voraussetzungen:

  • Eine NPM und NodeJS kompatible Serverarchitektur

  • NPM Version > 5.6.0

  • NVM Version > 0.33.8

  • NodeJS Version > 8.10.0

  • HTTPS SSL Zertifikat (lets encrypt oder acme.sh oder aus anderer Quelle)

  • Port Freigabe in der Firewall

NodeJS Einrichtung

  • Nach der Installation kann das Repository in ein Verzeichnis Ihrer Wahl geclont oder entpackt werden.

  • „npm install“ – zur Installation aller benötigten Packages nach package.json ausfüllen.

  • Im Projekt die .env Datei öffnen oder anlegen und die benötigten Daten entsprechend ausfüllen:

    • SERVER_PORT = XXXX
  • In den Ordner ssl die benötigten SSL Zertifikate kopieren oder verlinken:

    • online.domain.com-cert.pem
    • online.domain.com-key.pem
  • „npm start“ ausführen.

Endpoints

  • https://url/agb -> url ist die Domain des betreffenden Servers!

  • Übergeben werden müssen im Body:

    • text -> Die zu prozessierende AGB.
    • search -> Ein Array aus Begriffen nach denen im Text gesucht werden soll.

Acknowledgments

This work is supported by the Internet Foundation Austria (IPA) via the netidee project ContractVis (no. 2116).

About

text processing components for highlighting and comparing lengthy legal texts

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •