Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/acdh-oeaw/voice-api

VOICE 3.0 backend API

https://github.com/acdh-oeaw/voice-api

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (6.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

VOICE 3.0 backend API

Basic Info
  • Host: GitHub
  • Owner: acdh-oeaw
  • License: mit
  • Language: JavaScript
  • Default Branch: main
  • Size: 38.4 MB
Statistics
  • Stars: 0
  • Watchers: 4
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 5 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

readme.md

voice-api

This is the API endpoint used by the voice-fe user interface. Search requests are transformed to CQL and then passed on to a separate NoSketchEngine instance. The official instance is not open to public access. But using the VOICE 3.0 XML files you can run your own instance.

xml

A swagger UI and an openapi.json endpoint is built into the API.

Short summary:

text /xml/ - List Ids /xml/LEcon329/file - Get XML-File /xml/LEcon329/header - Get TEI Header /xml/LEcon329/body - Get TEI Body /xml/LEcon329/uid/LEcon329_u_15 - Get u-Tag /xml/*/uid/LEcon329_u_15;LEcon329_u_16 - Get u-Tags from any Document

Dev

bash nodemon --inspect app.js

Local testing

To make sure your tests run in the AutoDevOps pipline you can test the test stage locally using your own docker instance like this

bash docker run --rm -v $(pwd):/tmp/app gliderlabs/herokuish /bin/herokuish buildpack test

powershell docker run --rm -v ${PWD}:/tmp/app gliderlabs/herokuish /bin/herokuish buildpack test

Search engine

The search engine used here is the NoSketchEngine. NoSketchEngine

https://nlp.fi.muni.cz/trac/noske

Credits:

RYCHLÝ, Pavel. Manatee/Bonito-A Modular Corpus Manager. In: RASLAN. 2007. p. 65-70.

KILGARRIFF, Adam, et al. The Sketch Engine: Ten Years on. Lexicography, 2014, 1.1: 7-36.

The search engine used can be changed using the NOSKEBONITO environment variable. e. g. `NOSKEBONITO=http://localhost:4000/bonito/run.cgi`

Owner

  • Name: Austrian Centre for Digital Humanities & Cultural Heritage
  • Login: acdh-oeaw
  • Kind: organization
  • Email: acdh@oeaw.ac.at
  • Location: Vienna, Austria

GitHub Events

Total
  • Push event: 2
Last Year
  • Push event: 2

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

package-lock.json npm
  • 728 dependencies
package.json npm
  • async ^3.2.3 development
  • del ^6.0.0 development
  • git-describe ^4.1.0 development
  • gulp ^4.0.2 development
  • gulp-token-replace ^1.1.5 development
  • jest ^27.5.1 development
  • license-report ^5.0.2 development
  • chevrotain ^10.1.2
  • cors ^2.8.5
  • express ^4.17.3
  • express-jsdoc-swagger ^1.6.7
  • sax ^1.2.4
.github/workflows/starter.yaml actions