diff --git a/CorpusAnalysisClient.js.md b/CorpusAnalysisClient.js.md new file mode 100644 index 00000000..6f19fc6e --- /dev/null +++ b/CorpusAnalysisClient.js.md @@ -0,0 +1,50 @@ +# Corpus Analysis + +## Start einer Session + +```javascript +nopaque.socket.emit("corpus_analysis_init", ); + ~ number +// Show init loading modal + +nopaque.socket.on("corpus_analysis_init", ); + ~ {"code": , "msg": } + ~ number // HTTP status code + ~ string +// Hide init loading modal +``` + +## Ausführen einer Suchanfrage + +Ergebnisse werden Stückchenweise als "chunks" übertragen. + +```javascript +nopaque.socket.emit("corpus_analysis_query", ); + ~ string +// Clear result data store and list +result = {"query": }; +// Hide query result card +// Show query loading card +nopaque.socket.on("corpus_analysis_query", ); + : {"code": , "result": } + ~ number // Error, Success + ~ {"matches": [, ...], + "num_matches": , + "cpos_lookup": {: , ...}, + "text_lookup": {: , ...}} + ~ number + ~ number + ~ {"word": , "lemma": , "simple_pos": , "pos": , "ner": , "text": , "s": } + ~ string + ~ string + ~ string + ~ string + ~ string + ~ number + ~ number + ~ {"author": , "title": , ...} + ~ string +// Process response +// Hide query result card +// Show query loading card +``` diff --git a/docker-compose.yml b/docker-compose.yml index d39bcbc2..89b2db80 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -20,8 +20,6 @@ services: depends_on: - db - redis - deploy: - replicas: 25 environment: - VIRTUAL_HOST=nopaque.localhost,129.70.216.233 env_file: nopaque.env diff --git a/nopaque.env.tpl b/nopaque.env.tpl index 19736f22..aa8a6cdc 100644 --- a/nopaque.env.tpl +++ b/nopaque.env.tpl @@ -8,6 +8,10 @@ DOCKER_CERT_PATH= DOCKER_HOST= DOCKER_TLS_VERIFY= +### GitLab Registry ### +GITLAB_USERNAME= +GITLAB_PASSWORD= + ### Flask ### FLASK_CONFIG= # SECRET_KEY=