Deprecated

The digapp-ht project is now deprecated. Please move to the dig-ui project for the latest releases and future development.

digapp-ht

DIG search and visualization user interface for the HT domain

Technologies

• Polymer
• Node.js
• Express.js
• Gulp.js
• Bower
• Web Component Tester
• Vulcanize
• Docker
• Lodash
• JSCS
• JSHint
• Polymer Elements
• DIG Elements
  • Elastic Search Client
  • Elastic.js

Installation

npm install -g gulp-cli
npm install -g gulp
npm install -g bower
npm install -g polyserve
npm install -g web-component-tester
git clone https://github.com/NextCenturyCorporation/digapp-ht.git
cd digapp-ht
npm install
bower install

Configuration

Copy digapp-ht/server/config/local.env.sample.js to digapp-ht/server/config/local.env.js and edit the available configuration options:

Configuration Option	Description	Default
ELASTIC_CONFIG	The address at which elasticsearch is hosted.	{"host": "http://localhost:9200"}
ELASTIC_INDEX	The elasticsearch index in which the HT ads (and other data) are located.	"dig-data"
ANNOTATION_INDEX	The elasticsearch index in which the user annotations are located.	"dig-annotations"
ANNOTATION_TYPE	The elasticsearch index type of the user annotations.	"annotation"
ANNOTATION_RELEVANT	The label describing why the user annotations are relevant.	"to a counter-human-trafficking case"
CACHE_CONFIG	The address at which elasticsearch is hosted in which the cached ads are located.	{"host": "http://localhost:9200"}
CACHE_INDEX	The elasticsearch index in which the cached HT ads are located.	"memex-domains"
CLASSIFICATION_AUTH	The authorization needed to use the classification REST service. Only used if DEV is true.	'{"user": "", "password": ""}'
CLASSIFICATION_ENTITY_URL	The address at which the classification REST service is located to POST entity classifications. Only used if DEV is true.
CLASSIFICATION_EXTRACTION_URL	The address at which the classification REST service is located to POST extraction classifications. Only used if DEV is true.
CLASSIFICATION_FLAG_URL	The address at which the classification REST service is located to GET classification flags. Only used if DEV is true.
DEV	Whether to enable development mode.	false
FILTER_STATES_INDEX	The elasticsearch index in which the filter states are located.	"dig-filter-states"
FILTER_STATES_TYPE	The elasticsearch index type of the filter states.	"item"
IMAGE_SERVICE_AUTH	The authorization needed to use the similar image REST service.	'{"user": "", "password": ""}'
IMAGE_SERVICE_HOST	The address at which the similar image REST service is located. The "url" is for GET requests sending a specific image URL. The "base64" is for POST requests sending specific image base64 data.	{"url": "", "base64": ""}
IMAGE_URL_PREFIX	The prefix for all image URLs.	''
DOWNLOAD_IMAGE_URL	The image download endpoint for the PDF downloads.	'downloadImage'
LOG_INDEX	The elasticsearch index in which the logs are located.	"dig-logs"
LOG_TYPE	The elasticsearch index type of the logs.	"log"
RAW_ES_DATA_URL	The endpoint at which the elasticsearch data can be found. The document _id is added to the end of the property string. Links are shown with results if the property is defined.
USER_INDEX	The elasticsearch index in which the users are located.	"dig-users"
USER_TYPE	The elasticsearch index type of the users.	"user"

Run Local Server

gulp serve

Run Codestyle & Linter

gulp lint

Run Unit Tests

gulp test

Build & Vulcanize

First update the application version in package.json. Then run:

gulp

Build & Deploy Docker Image

First update the application version in package.json. Then run:

gulp docker

This will build & vulcanize the application, build a docker image named digmemex/digapp:[version] (using the version from the package.json file) and push it to Docker Hub.

License

Apache 2.0