{"id":23477484,"url":"https://github.com/rwth-acis/ocd-web-client","last_synced_at":"2025-04-13T13:49:14.211Z","repository":{"id":21992026,"uuid":"25317033","full_name":"rwth-acis/OCD-Web-Client","owner":"rwth-acis","description":"This repository contains the code of the Web client for the OCD service.","archived":false,"fork":false,"pushed_at":"2024-06-07T15:07:40.000Z","size":1935,"stargazers_count":3,"open_issues_count":10,"forks_count":3,"subscribers_count":36,"default_branch":"master","last_synced_at":"2025-02-16T07:27:56.641Z","etag":null,"topics":["las2peer","web-client","webocd"],"latest_commit_sha":null,"homepage":"http://webocd.dbis.rwth-aachen.de/OCDWebClient/login.html","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rwth-acis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2014-10-16T19:01:59.000Z","updated_at":"2022-06-17T14:53:35.000Z","dependencies_parsed_at":"2024-03-12T13:43:16.561Z","dependency_job_id":"7d2abc08-0650-433e-8c68-9d7deb711681","html_url":"https://github.com/rwth-acis/OCD-Web-Client","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2FOCD-Web-Client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2FOCD-Web-Client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2FOCD-Web-Client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rwth-acis%2FOCD-Web-Client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rwth-acis","download_url":"https://codeload.github.com/rwth-acis/OCD-Web-Client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248724485,"owners_count":21151559,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["las2peer","web-client","webocd"],"created_at":"2024-12-24T18:27:15.278Z","updated_at":"2025-04-13T13:49:14.192Z","avatar_url":"https://github.com/rwth-acis.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OCD-Web-Client\nThis repository contains the code of the web client for the OCD service at https://github.com/rwth-acis/REST-OCD-Services. As the WebClient only acts as the UI of WebOCD, you will need to have an instance of the service running as well.\n\n# Quick Set-Up Guide\n### Client Configuration at Learning Layers\nTo set up the Learning layers OIDC login, either use an existing Learning Layers client or register your own at https://auth.las2peer.org/auth/realms/main/account/ (You'll need a learning layers Account).\nThe client at learning Layers has to have the following configurations:\n* The web clients login page has to be mentioned as a _Redirect URI_\n* The _Access Type_ should be public and you should use _Implicit Flow_\n* You need to have your clients' origin, e.g. ``http://localhost:\u003cyour-port\u003e``, and ``https://api.learning-layers.eu/*`` as an allowed _Web Origin_ (Lazy People can just use ``*`` to allow any). Keep in mind that it needs to be the **exact** origin, an extra ``/`` may for example lead to a CORS policy block.\n\n### Adjusting the Files\nYou will then have to change the _data-clientid_ field to your client id from Learning Layers and the _data-redirecturi_ field to your web clients address (usually something like ``http://localhost:\u003cyour-port\u003e``). This has to be done in both.\n* login.html\n* JS/contentHandler.js\n\nFinally, change the values of _baseUrl_ to the [services](https://github.com/rwth-acis/REST-OCD-Services) address in the following files so that requests are addressed to it:\n* JS/requestHandler.js\n* JS/simulation/requestHandler.js\n* JS/simulation/jsonRequestHandler.js\n\nFinally, dont forget to run ``npm install`` to get all the needed packages. \n\nYou can then for example use the http-server package dependency of the web client to have the server running: Do ``./node_modules/.bin/http-server -p \u003cyour-port\u003e`` (or ``npx http-server -p \u003cyour-port\u003e``) from the root directory of the project and optionally add ``-c-1`` to disable caching. Now, the web client should be able to communicate with the OCD service and be reachable under ``http://localhost:\u003cyour-port\u003e``.\n\nNow, the web client should be able to communicate with the OCD service.\n\n# Quickstart with a Docker Container\nTo build a docker image for the OCD-Web-Client that connects to the WebOCD Service running locally with the default parameters, you can navigate to the OCD-Web-Client directory and execute \n```\ndocker build -t \u003cimage_name\u003e .\n```\n\nTo run a docker container interactively, based on the above created image that connects to the default address of ``http://localhost:\u003cyour-port\u003e`` you can execute\n\n```\ndocker run -it -p \u003cyour-port\u003e:8090 \u003cimage_name\u003e \n```\n\nNow you should be able to navigate to ``http://localhost:\u003cyour-port\u003e`` and communicate with the service as you would without docker \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-acis%2Focd-web-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frwth-acis%2Focd-web-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-acis%2Focd-web-client/lists"}