Skip to content

jameshnsears/xqa-query-ui

Repository files navigation

xqa-query-ui Build Status Coverage Status sonarcloud Codacy Badge

  • UI for querying XQA.

1. Screenshots

XQuery

Search

2. High Level Design

High Level Design

3. Install

  • sudo apt purge npm
  • sudo apt install npm
  • npm install # using package.json

3.1. (optional) Update package.json

npm install npm-check-updates

node_modules/npm-check-updates/bin/ncu

node_modules/npm-check-updates/bin/ncu -u

4. Build locally

./build.sh

5. Docker

5.1. Populate environment with data

  • populate xqa-shard(s) and xqa-db using xqa-test-data:
./start.sh
  • wait until data in xqa:
    • docker logs xqa-ingest | grep "FINISHED - sent: 40/40"
    • docker-compose logs -f xqa-shard | grep "size="

5.2. Bring up

6. Run from CLI

  • node_modules/@angular/cli/bin/ng serve --open

or

  • node_modules/@angular/cli/bin/ng serve --open --env=prod

6.1. Testing the .spec.ts files

  • node_modules/@angular/cli/bin/ng test --code-coverage --watch false

  • visit: xqa-query-ui/coverage/index.html

6.1. Debug in VSC

  • Debugger for Chrome extension installed.
  • In Debug Window, Launch Chrome (xqa-query-ui) & set a breakpoint.

7. Test

8. Teardown

./stop.sh

Releases

No releases published

Packages

No packages published