https://github.com/acdh-oeaw/vicav-app

A map-based web application for VICAV project.

https://github.com/acdh-oeaw/vicav-app

Science Score: 36.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
  • Committers with academic emails
    5 of 12 committers (41.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.2%) to scientific vocabulary

Keywords

application basex css html5 javascript xquery xslt

Keywords from Contributors

interactive projection archival sequences observability autograding hacking shellcodes modular network-simulation
Last synced: 5 months ago · JSON representation

Repository

A map-based web application for VICAV project.

Basic Info
Statistics
  • Stars: 4
  • Watchers: 7
  • Forks: 1
  • Open Issues: 17
  • Releases: 0
Topics
application basex css html5 javascript xquery xslt
Created about 8 years ago · Last pushed 6 months ago
Metadata Files
Readme

README.md

VICAV Web Page

A map-based web application for the VICAV project.

Set up a local instance

Prerequisites

  • Java LTS (Oracle, Azul, or others) (17 at the moment)
  • Node LTS (18 at the moment)
  • git (for Windows, shipped with other OSes)
  • curl for downloading Saxon HE (10.3 at the moment, curl is included with git for windows)
  • This git repository needs to be cloned inside a BaseX ZIP-file distribution (please use 9.7.3 at the moment, version 10.x will be supported soon)

Setup

  • unzip BaseX.zip (for example in your home folder) <basexhome> is the directory containing BaseX.jar and the bin, lib and webapp directory (basex after unpacking the BaseX.zip file, but you should probably rename it)
  • in <basexhome>/webapp git clone this repository, please do not change the name vicav-app
  • start a bash in <basexhome>/webapp/vicav-app
  • run git submodule update --init --recursive
  • optionally set the CONTENTREPOsitory and the CONTENTBRANCH bash # default settings if unset export CONTENT_REPO=https://github.com/acdh-oeaw/vicav-content export CONTENT_BRANCH=master
  • run ./deployment/initial.sh

This will clone vicav-content into <basexhome>.

Update data and web page code

In <basexhome> execute ./redeploy.sh

Then if

Tests

3 types of tests: * XSPEC for unit testing the XSL transformations in ./xslt, * XUnit for testing basex API endpoint outputs * Cypress for end-to-end testing of the frontend features

Test data is located in ./fixtures. Before running tests locally, you have to setup your test environment with the fixtures.

Tests are automatically executed upon a git push on Gitlab. See https://gitlab.com/acdh-oeaw/vicav/vicav-app/-/pipelines.

To run tests locally you need to tell the scripts where to find BaseX using the CYPRESSBASEXROOT environment variable. E.g.: powershell $env:CYPRESS_BASEX_ROOT="<basexhome>" npm run test

XSpec

Installation: Download xspec from https://github.com/xspec/xspec Running a test file: 1a. Windows: <xspechome>/bin/xspec.sh FILENAME 1b. Linux, mac: run <xspechome>/bin/xspec.sh FILENAME

Run xUnit:

Running a test file: Run <basexhome>/bin/basex -t FILENAME

Run cypress

Installation: * install nodejs and npm * run npm install

Running tests: Either open the GUI with npm run cypress:open or run them on command line with npm run cypress:run.

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
  • Issues event: 36
  • Watch event: 1
  • Delete event: 10
  • Issue comment event: 35
  • Push event: 91
  • Pull request review event: 1
  • Pull request event: 27
  • Create event: 17
Last Year
  • Issues event: 36
  • Watch event: 1
  • Delete event: 10
  • Issue comment event: 35
  • Push event: 91
  • Pull request review event: 1
  • Pull request event: 27
  • Create event: 17

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 946
  • Total Committers: 12
  • Avg Commits per committer: 78.833
  • Development Distribution Score (DDS): 0.624
Past Year
  • Commits: 117
  • Committers: 4
  • Avg Commits per committer: 29.25
  • Development Distribution Score (DDS): 0.521
Top Committers
Name Email Commits
Omar Siam O****m@o****t 356
Zsofia Abraham z****m@o****t 356
Charly Mörth K****h@o****t 112
Asil Çetin a****n 78
Daniel Schopper d****r@o****t 18
kisram s****m@u****e 8
Mau Palantír m****r@g****m 6
dependabot[bot] 4****] 5
Zsofia Mau Abraham a****u@g****m 3
Daniel Schopper d****r@a****s 2
Alexander Watzinger a****r@c****t 1
Mau Zsofia Abraham M****u@M****l 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 61
  • Total pull requests: 59
  • Average time to close issues: 9 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 7
  • Total pull request authors: 3
  • Average comments per issue: 0.41
  • Average comments per pull request: 0.36
  • Merged pull requests: 49
  • Bot issues: 0
  • Bot pull requests: 9
Past Year
  • Issues: 18
  • Pull requests: 13
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 6 days
  • Issue authors: 4
  • Pull request authors: 3
  • Average comments per issue: 0.78
  • Average comments per pull request: 0.54
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 2
Top Authors
Issue Authors
  • asilcetin (25)
  • simar0at (17)
  • dasch124 (11)
  • MauPalantir (5)
  • ctot-nondef (1)
  • charlymo (1)
  • kisram (1)
Pull Request Authors
  • MauPalantir (67)
  • dependabot[bot] (9)
  • simar0at (3)
  • dasch124 (1)
Top Labels
Issue Labels
TUNOCENT (5) bug (3) enhancement (3) SHAWI (2) invalid (1) epic (1) profiles (1) WIBARAB (1) sample texts (1)
Pull Request Labels
dependencies (9) needs review (2) javascript (2) work-in-progress (1) enhancement (1) bug (1)

Dependencies

.github/workflows/starter.yaml actions