Knora (Knowledge Organization, Representation, and Annotation) is a server application for storing, sharing, and working with primary sources and data in the humanities.
- Stores humanities data as industry-standard RDF graphs, plus files for binary data such as digitized primary sources.
- Designed to work with any standards-compliant RDF triplestore. Tested with Ontotext GraphDB.
- Based on OWL ontologies that express abstract, cross-disciplinary commonalities in the structure and semantics of research data.
- Offers a generic HTTP-based API, implemented in Scala, for querying, annotating, and linking together heterogeneous data in a unified way.
- Handles authentication and authorization.
- Provides automatic versioning of data.
- Uses Sipi, a high-performance media server implemented in C++.
- Designed to be be used with SALSAH, a general-purpose, browser-based virtual research environment, as well as with custom user interfaces.
New features under development
For developing and testing the API server
Ontotext GraphDB is recommended. Support for other RDF triplestores is planned.
For building the documentation
Try it out
Quick Installation Guide for Knora, Salsah, Sipi and GraphDB
A manual to get all mentioned components locally up and running can be found here.
Run the Knora API server
$ docker run --rm -p 7200:7200 dhlabbasel/graphdb-free
Then in another terminal, create a test repository and load some test data into the triplestore:
$ cd webapi/scripts $ ./graphdb-free-docker-init-knora-test.sh
Then go back to the webapi root directory and use SBT to start the API server:
$ cd .. $ sbt > compile > set reStart / javaOptions ++= Seq("-Dapp.triplestore.dbtype=graphdb-free") > reStart
Then try opening http://localhost:3333/v1/resources/http%3A%2F%2Frdfh.ch%2Fc5058f3a in a web browser. You should see a response in JSON describing a book.
To shut down the Knora API server:
Run the automated tests
Make sure you've started GraphDB Free as shown above. Create an empty repository for running the automated tests:
$ cd webapi/scripts $ ./graphdb-free-init-knora-test-unit.sh
Then at the SBT prompt:
> GDBFree / test
How to Contribute
You can help by testing Knora with your data, making bug reports, improving the documentation, and adding features that you need.
camelCase for names of classes, variables, and functions. Make names descriptive, and don't worry if they're long.
Format your code consistently. We IntelliJ IDEA to format code, with 4 spaces indentation. Use whitespace to make your code easier to read. Add lots of implementation comments describing what your code is doing, how it works, and why it works that way.
There are three sets of automated tests:
- Unit tests, route-to-route tests, and end-to-end tests are under
webapi/src/test. To run these, type
graphdb-free:test(depending on which triplestore you're using) at the SBT console in the
webapiproject. To run a single test, use
- Integration tests, which can involve Sipi, are under
src/it. To run these, first start Sipi, then type
it:testat the SBT console in the
- Browser interaction tests are under
salsah/src/test, and are written using Selenium. To run these, you will need to unpack the correct ChromeDriver for your platform found under
salsah/lib/chromedriverand put it in the same folder. Then start Sipi and the Knora API server, and type
testat the SBT console in the
Whenever you add a new feature or fix a bug, you should add one or more tests for the change you made.
A pull request should include tests and documentation for the changes that were made. See the documentation README for information on writing Knora documentation.
Please use the knora-user mailing list for technical questions.
Commit Message Schema
When writing commit messages, we stick to this schema:
type (scope): subject body
- feature (new feature for the user)
- fix (bug fix for the user)
- docs (changes to the documentation)
- style (formatting, etc; no production code change)
- refactor (refactoring production code, eg. renaming a variable)
- test (adding missing tests, refactoring tests; no production code change)
- build (changes to sbt tasks, CI tasks, deployment tasks, etc.; no production code changes)
- enhancement (residual category)
feature (resources route): add route for resource creation - add path for multipart request - adapt handling of resources responder
Release Versioning Convention
The Knora project is following the Semantic Versioning convention for numbering the releases as defined by [http://semver.org]:
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.
Additionally, we will also increment the MAJOR version in the case when any kind of changes to existing data would be necessary, e.g., any changes to the Knora-Base ontologies which are not backwards compatible.
The Knora project is using YourKit for profiling.
YourKit supports open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.