https://github.com/rwth-acis/ocd-web-client
This repository contains the code of the Web client for the OCD service.
https://github.com/rwth-acis/ocd-web-client
las2peer web-client webocd
Last synced: about 2 months ago
JSON representation
This repository contains the code of the Web client for the OCD service.
- Host: GitHub
- URL: https://github.com/rwth-acis/ocd-web-client
- Owner: rwth-acis
- License: other
- Created: 2014-10-16T19:01:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-07T15:07:40.000Z (about 1 year ago)
- Last Synced: 2025-02-16T07:27:56.641Z (4 months ago)
- Topics: las2peer, web-client, webocd
- Language: HTML
- Homepage: http://webocd.dbis.rwth-aachen.de/OCDWebClient/login.html
- Size: 1.85 MB
- Stars: 3
- Watchers: 36
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OCD-Web-Client
This 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.
# Quick Set-Up Guide
### Client Configuration at Learning Layers
To 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).
The client at learning Layers has to have the following configurations:
* The web clients login page has to be mentioned as a _Redirect URI_
* The _Access Type_ should be public and you should use _Implicit Flow_
* You need to have your clients' origin, e.g. ``http://localhost:``, 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.
### Adjusting the Files
You 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:``). This has to be done in both.
* login.html
* JS/contentHandler.js
Finally, 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:
* JS/requestHandler.js
* JS/simulation/requestHandler.js
* JS/simulation/jsonRequestHandler.js
Finally, dont forget to run ``npm install`` to get all the needed packages.
You 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 `` (or ``npx http-server -p ``) 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:``.
Now, the web client should be able to communicate with the OCD service.
# Quickstart with a Docker Container
To 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
```
docker build -t .
```
To run a docker container interactively, based on the above created image that connects to the default address of ``http://localhost:`` you can execute
```
docker run -it -p :8090
```
Now you should be able to navigate to ``http://localhost:`` and communicate with the service as you would without docker