https://github.com/dasch-swiss/knora-ui

Reusable GUI elements for Knora

https://github.com/dasch-swiss/knora-ui

Science Score: 10.0%

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

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    5 of 10 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary

Keywords

angular angular-material npm-module npm-package

Keywords from Contributors

angular-library demo-application dsp
Last synced: 5 months ago · JSON representation

Repository

Reusable GUI elements for Knora

Basic Info
Statistics
  • Stars: 7
  • Watchers: 9
  • Forks: 0
  • Open Issues: 69
  • Releases: 0
Archived
Topics
angular angular-material npm-module npm-package
Created almost 8 years ago · Last pushed over 4 years ago
Metadata Files
Readme Changelog

README.md

Knora-ui modules

Codacy Badge Build Status CircleCI

This is the demo and developing environment for Knora ui modules.

The modules helps to create a graphical user interface, a web application to use Knora in a quick and simple way. The modules are written in typescript to use them with Angular (version 8). We decided to style the components and directives with material design.

But you can use only @knora/core which contains almost all services for the Knora web API. Knora is a software framework for storing, sharing, and working with primary sources and data in the humanities.

Knora and the Knora ui modules is free software, released under the GNU Affero General Public.

This version of Knora-ui requires Knora-api version ^12.0.0.

Published modules

@knora/core

npm

The core module contains every service to use Knora's RESTful webapi. read more...


@knora/search

npm

Search module allows to make simple searches or extended searches in Knora. In extended search, resource class and its properties related to one specific ontology are selected to create your query. read more...


@knora/viewer

npm

The viewer module contains object components to show the resource class representations from Knora, the gui-elements for the property values and different kind of view frameworks. read more...


@knora/action

npm

The action module contains special buttons (e.g. to sort a list), pipes and directives. read more...


Developers note

Prerequisites

We develop the Knora-ui modules with Angular 8, especially with Angular-cli, which requires the following tools:

Yarn

We use yarn instead of npm. To install yarn on macOS:

bash $ brew install yarn

For other platforms, please go to the yarn website.

Node

Install Node in version 10.9.0 or later. The easiest way to install node in the correct version is to use 'n':

bash $ yarn global add n $ n v10.9.0

First steps

Install the node packages with:

bash $ yarn install --prod=false

and build the libraries with:

bash $ yarn build-lib

Develop

If you want to add more components, services and so on to a module library, you can do it with:

$ ng generate component [path/in/your/module/][name-of-component] --project @knora/[module-name] --styleext scss

It puts the component or the service into lib/ directly. Otherwise you can define a path inside of lib/.

Before using the module inside of the app, you have to rebuild after the changes: ng build @knora/[module-name].

Run the demo app

Run the app with ng s. The demo app runs on http://0.0.0.0:4200 and we use it for documentation on Knora-ui Github page.

There's a test environment for the modules on https://github.com/dhlab-basel/knora-ui-playground with yalc


YALC

Better workflow than npm | yarn link for package authors.

Yalc publishes the packages to a local store (not the npm website). From there, the packages can be added to your depending project.

Install yalc:

bash $ yarn global add yalc

Usage

Publish library to local store:

bash $ yarn build-lib-prod $ yarn yalc-publish

Use them in your application:

bash $ yalc add @knora/action $ yalc add @knora/core $ yalc add @knora/search $ yalc add @knora/viewer

To remove from the project and restore package.json run:

bash $ yalc remove --all

Owner

  • Name: DaSCH - Swiss National Data and Service Center for the Humanities
  • Login: dasch-swiss
  • Kind: organization
  • Email: info@dasch.swiss
  • Location: Switzerland

Development repositories of the DaSCH.

GitHub Events

Total
Last Year

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 673
  • Total Committers: 10
  • Avg Commits per committer: 67.3
  • Development Distribution Score (DDS): 0.698
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Flavie Laurens f****o@h****r 203
André Kilchenmann g****b@m****h 193
André Kilchenmann a****n@u****h 153
Flavie L f****s@u****h 52
Tobias Schweizer t****r@u****h 29
Tobias Schweizer t****r@u****m 22
Ivan Subotic i****s@s****h 10
dependabot-preview[bot] 2****]@u****m 9
Sepideh Alassi s****i@u****h 1
Benjamin Geer b****r@u****h 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 165
  • Total pull requests: 108
  • Average time to close issues: 6 months
  • Average time to close pull requests: 3 months
  • Total issue authors: 7
  • Total pull request authors: 4
  • Average comments per issue: 1.14
  • Average comments per pull request: 0.89
  • Merged pull requests: 38
  • Bot issues: 0
  • Bot pull requests: 58
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
Top Authors
Issue Authors
  • flavens (33)
  • tobiasschweizer (11)
  • kilchenmann (8)
  • benjamingeer (3)
  • subotic (3)
  • SepidehAlassi (2)
  • mrivoal (1)
Pull Request Authors
  • dependabot[bot] (22)
  • flavens (8)
  • kilchenmann (6)
  • tobiasschweizer (3)
Top Labels
Issue Labels
enhancement (34) stage/backlog (21) documentation (11) refactor (9) breaking (6) chore (4) bug (4) styling (3) testing (3) stage/in-progress (3) warning (2) question (2) codetree-epic (1) help wanted (1) build (1)
Pull Request Labels
dependencies (22) enhancement (7) bug (5) chore (4) documentation (2) refactor (1) warning (1) breaking (1)

Packages

  • Total packages: 5
  • Total downloads:
    • npm 656 last-month
  • Total dependent packages: 5
    (may contain duplicates)
  • Total dependent repositories: 6
    (may contain duplicates)
  • Total versions: 186
  • Total maintainers: 4
npmjs.org: @knora/search

Knora ui module: search

  • Versions: 34
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 163 Last month
Rankings
Downloads: 7.2%
Dependent repos count: 10.3%
Stargazers count: 10.4%
Forks count: 11.6%
Average: 12.1%
Dependent packages count: 20.9%
Last synced: 6 months ago
npmjs.org: @knora/core

Knora ui module: core

  • Versions: 47
  • Dependent Packages: 1
  • Dependent Repositories: 2
  • Downloads: 138 Last month
Rankings
Dependent repos count: 7.6%
Stargazers count: 10.5%
Forks count: 11.6%
Downloads: 11.9%
Average: 12.5%
Dependent packages count: 21.0%
Last synced: 6 months ago
npmjs.org: @knora/action

Knora ui module: action

  • Versions: 41
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 158 Last month
Rankings
Dependent repos count: 10.3%
Stargazers count: 10.5%
Forks count: 11.6%
Average: 13.4%
Downloads: 13.7%
Dependent packages count: 21.0%
Last synced: 6 months ago
npmjs.org: @knora/authentication

Knora ui module: authentication

  • Versions: 34
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 40 Last month
Rankings
Dependent repos count: 10.3%
Stargazers count: 10.5%
Forks count: 11.6%
Average: 13.6%
Downloads: 14.7%
Dependent packages count: 21.0%
Last synced: 6 months ago
npmjs.org: @knora/viewer

Knora ui module: viewer

  • Versions: 30
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 157 Last month
Rankings
Dependent repos count: 10.3%
Stargazers count: 10.5%
Forks count: 11.6%
Average: 13.7%
Downloads: 15.1%
Dependent packages count: 21.0%
Last synced: 6 months ago

Dependencies

package.json npm
  • @angular-devkit/build-angular ~0.803.7 development
  • @angular-devkit/build-ng-packagr ~0.803.14 development
  • @angular/cli ^8.3.7 development
  • @angular/compiler-cli ^8.2.9 development
  • @angular/language-service ^8.2.12 development
  • @types/jasmine ~3.4.4 development
  • @types/jasminewd2 ~2.0.3 development
  • @types/node ~8.9.4 development
  • @types/prismjs ^1.9.0 development
  • codelyzer ~5.0.1 development
  • jasmine-core ~3.5.0 development
  • jasmine-marbles ^0.6.0 development
  • jasmine-spec-reporter ~4.2.1 development
  • karma ~4.1.0 development
  • karma-chrome-launcher ~2.2.0 development
  • karma-cli ~1.0.1 development
  • karma-coverage-istanbul-reporter ~2.1.0 development
  • karma-html-detailed-reporter ^1.1.38 development
  • karma-jasmine ~2.0.1 development
  • karma-jasmine-html-reporter ^1.4.2 development
  • karma-spec-reporter ^0.0.32 development
  • ng-packagr ^5.7.0 development
  • popper.js ^1.14.7 development
  • protractor ~5.4.0 development
  • ts-node ~8.4.1 development
  • tsickle ^0.36.0 development
  • tslib ^1.10.0 development
  • tslint ~5.20.0 development
  • typescript 3.4.5 development
  • @angular/animations ^8.2.9
  • @angular/cdk ^8.2.3
  • @angular/common ~8.2.9
  • @angular/compiler ~8.2.9
  • @angular/core ^8.2.9
  • @angular/flex-layout ^8.0.0-beta.27
  • @angular/forms ~8.2.9
  • @angular/material ^8.2.3
  • @angular/platform-browser ~8.2.9
  • @angular/platform-browser-dynamic ~8.2.9
  • @angular/router ~8.2.9
  • @auth0/angular-jwt ^2.0.0
  • @knora/api 0.2.0
  • angular-split ^3.0.2
  • core-js ^2.5.4
  • global ^4.3.2
  • hammerjs ^2.0.8
  • jdnconvertiblecalendar ^0.0.5
  • jdnconvertiblecalendardateadapter ^0.0.10
  • json2typescript ^1.2.3
  • jsonld ^1.0.2
  • material-icons ^0.3.1
  • moment ^2.22.2
  • ngx-markdown ^8.2.1
  • node-sass ^4.9.3
  • openseadragon ^2.4.0
  • prismjs ^1.15.0
  • rxjs ^6.5.2
  • semver ^6.1.1
  • svg-overlay github:openseadragon/svg-overlay
  • ts-md5 ^1.2.4
  • zone.js 0.9.1
yarn.lock npm
  • 1258 dependencies