{"id":41808336,"url":"https://github.com/edmcouncil/onto-viewer","last_synced_at":"2026-01-25T06:56:36.613Z","repository":{"id":36963696,"uuid":"206280274","full_name":"edmcouncil/onto-viewer","owner":"edmcouncil","description":"OntoViewer is an open-source project that is hosted by EDM Council. The project started in May 2019. OntoViewer is a JAVA application that is specifically designed to access both the ontology structure and its content in the easiest possible way. OntoViewer servers both as a web application and REST API.","archived":false,"fork":false,"pushed_at":"2024-12-13T09:46:50.000Z","size":6648,"stargazers_count":29,"open_issues_count":7,"forks_count":10,"subscribers_count":9,"default_branch":"develop","last_synced_at":"2024-12-13T10:41:04.780Z","etag":null,"topics":["auto-viewer","fibo-viewer","java","java-application","onto-viewer","ontology-documentation","ontology-search"],"latest_commit_sha":null,"homepage":"https://spec.edmcouncil.org/fibo/ontology","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/edmcouncil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-04T09:17:53.000Z","updated_at":"2024-12-13T09:46:56.000Z","dependencies_parsed_at":"2024-08-09T13:10:57.436Z","dependency_job_id":null,"html_url":"https://github.com/edmcouncil/onto-viewer","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/edmcouncil/onto-viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmcouncil%2Fonto-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmcouncil%2Fonto-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmcouncil%2Fonto-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmcouncil%2Fonto-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edmcouncil","download_url":"https://codeload.github.com/edmcouncil/onto-viewer/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edmcouncil%2Fonto-viewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28747306,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T05:12:38.112Z","status":"ssl_error","status_checked_at":"2026-01-25T05:04:50.338Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["auto-viewer","fibo-viewer","java","java-application","onto-viewer","ontology-documentation","ontology-search"],"created_at":"2026-01-25T06:56:36.547Z","updated_at":"2026-01-25T06:56:36.605Z","avatar_url":"https://github.com/edmcouncil.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://github.com/edmcouncil/html-pages/raw/develop/general/assets/img/EDM-council-RGB_200w.png\" width=\"200\" align=\"right\"/\u003e\n\n# onto-viewer\n\nonto-viewer is an open-source Java application that provides a number of REST API endpoints to access the content of OWL ontologies. If run together with [html-pages frontend](https://github.com/edmcouncil/html-pages), it will visualise them as a web application.\n\n\n# Table of contents\n\n* [How to run onto-viewer](#how-to-run-onto-viewer)\n\t* [How to customise your ontology to be properly displayed by onto-viewer](#how-to-customise-ontologies)\n\t* [How to run it locally](#how-to-run-locally)\n\t* [How to run it using docker](#how-to-run-docker)\n* [Contributing](#contributing)\n  * [Development](#development)\n* [License](#license)\n\n\n# How to run onto-viewer\n\n## How to customise your ontology to be properly displayed by onto-viewer\n\n1. We require each _ontology IRI_ to follow the convention described in [Vocabularies that use a 'slash namespace'](https://www.w3.org/TR/swbp-vocab-pub/#slash), i.e. end with a forward slash character `/` (e.g., `https://www.omg.org/spec/Commons/Classifiers/`).\n1. We require that all ontologies are \"registered\" in the meta file(s), which store the relevant metadata, in particular allow for custom modularisation - see https://github.com/edmcouncil/idmp/blob/master/ISO/MetadataISO.rdf for an example of such file.\n1. We recommend that all imported ontologies and locally cached and their local references are listed in catalog-v001.xml file. \n\n## How to run it locally\n\nTo run the onto-viewer locally: \n\n* Download the file named \"onto-viewer.zip\" from the [latest release](https://github.com/edmcouncil/onto-viewer/releases). \n* Unzip the file. \n* In the command prompt of your operating system run the following command in the folder with the last release: \n\n```\njava -jar app-v-LAST_VERSION_NUMBER.war\n```\ne.g.,\n\n```\njava -jar app-v-0.1.0.war\n```\n\n\n## How to run it using docker\nRequirements:\n- [git](https://git-scm.com/) ([install](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git))\n- [docker](https://www.docker.com/) - install:\n  * [Docker Desktop](https://docs.docker.com/desktop/) or ...\n  * [Docker Engine](https://docs.docker.com/engine/) with [Docker Compose plugin](https://docs.docker.com/compose/)\n\n### ... with FIBO\n\nHow to start:\nClone the [edmcouncil/onto-viewer](https://github.com/edmcouncil/onto-viewer) repository to the *onto-viewer* directory,\ngo to the *onto-viewer* directory (run all subsequent commands inside this directory),\nthen build the images (or pull from the registry if available) and run the containers:\n```bash\n# clone the repository\ngit clone https://github.com/edmcouncil/onto-viewer onto-viewer\n\n# got to the onto-viewer directory\ncd onto-viewer\n\n# build images\ndocker compose build\n# alternatively pull images from registry if available\n#docker compose pull --ignore-pull-failures\n\n# run the containers\ndocker compose up -d\n```\n\nAfter some time, check the status of running containers:\n```\ndocker compose ps\n```\n\nif they work correctly, the following message will appear:\n```\nNAME                        IMAGE                           COMMAND                  SERVICE             CREATED             STATUS                   PORTS\nonto-viewer-fibo-pages-1    edmcouncil/fibo-pages:latest    \"docker-entrypoint.s…\"   fibo-pages          7 minutes ago       Up 6 minutes (healthy)   \nonto-viewer-fibo-strapi-1   edmcouncil/fibo-strapi:latest   \"docker-entrypoint.s…\"   fibo-strapi         7 minutes ago       Up 6 minutes (healthy)   \nonto-viewer-fibo-viewer-1   edmcouncil/onto-viewer:latest   \"sh entrypoint.sh\"       fibo-viewer         7 minutes ago       Up 6 minutes (healthy)   \nonto-viewer-spec-1          edmcouncil/spec:latest          \"/docker-entrypoint.…\"   spec                7 minutes ago       Up 6 minutes (healthy)   0.0.0.0:8080-\u003e80/tcp, :::8080-\u003e80/tcp\n\n```\n\nThe services provide endpoints at the following URLs:\n- [http://localhost:8080](http://localhost:8080) :- [html-pages home page](https://github.com/edmcouncil/html-pages/blob/develop/home/README.md)\n- [http://localhost:8080/fibo](http://localhost:8080/fibo) :- [html-pages general template](https://github.com/edmcouncil/html-pages/tree/develop/general) for [FIBO](https://github.com/edmcouncil/fibo) ontology\n- [http://localhost:8080/fibo/ontology](http://localhost:8080/fibo/ontology) :- onto-viewer for [FIBO](https://github.com/edmcouncil/fibo) ontology\n- [http://localhost:8080/fibo/strapi/admin](http://localhost:8080/fibo/strapi/admin) :- [Strapi admin panel](https://docs.strapi.io/user-docs/intro#accessing-the-admin-panel) for for [FIBO](https://github.com/edmcouncil/fibo) ontology (Email: *edmc-strapi@dev.com*, Password: *devDBonly1*)\n\nIt is also possible to build (or pull from the registry, if available) Docker images\nwith tag names other than the default `develop` - use environment variables:\n- `VIEWER_BRANCH` for `edmcouncil/onto-viewer`, e.g. for [edmcouncil/onto-viewer:build-dev](https://github.com/edmcouncil/onto-viewer/tree/build-dev):\n  ```bash\n  echo VIEWER_BRANCH=build-dev \u003e\u003e .env\n  ```\n- `HTML_BRANCH` for `edmcouncil/html-pages`, e.g. for [edmcouncil/html-pages:build-dev](https://github.com/edmcouncil/html-pages/tree/build-dev):\n  ```bash\n  echo HTML_BRANCH=build-dev \u003e\u003e .env\n  ```\n\n### ... with an ontology of your choice\n\nIt is possible to run containers with any ontology (instead of `FIBO`):\n- place the ontology files of your choice in the `onto-viewer-web-app/ontologies` subdirectory\n  and the config files in the `onto-viewer-web-app/config` subdirectory\n\n- using the `docker-compose.dev.yaml` compose file (instead of the default `docker-compose.yaml`),\n  build the images,then run the containers:\n  ```bash\n  echo COMPOSE_FILE=docker-compose.dev.yaml \u003e\u003e .env\n  docker compose build\n  docker compose up -d\n  ```\n\n  once all services are up and running, onto-viewer with your ontology will be available at `http://localhost:8080/dev/ontology`\n\nIf you want to see the logs use:\n```bash\n# to view continuous log output for \u003cSERVICE\u003e=dev-viewer\ndocker compose logs --follow dev-viewer\n\n# to view *100* latest log lines for \u003cSERVICE\u003e=dev-viewer\ndocker compose logs --tail 100 dev-viewer\n```\n\nStop the services with the command:\n```bash\ndocker compose down\n```\n\nRemove all images and volumes with the command:\n```bash\ndocker compose down --rmi all -v\n```\n\n# Contributing\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n\n## Development\n\nTo run integration tests, use the following command:\n\n```shell\nmvn -P integration-tests verify\n```\n\n\n# License\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedmcouncil%2Fonto-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedmcouncil%2Fonto-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedmcouncil%2Fonto-viewer/lists"}