Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uh-studentservices/eduviewer-frontend
https://github.com/uh-studentservices/eduviewer-frontend
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/uh-studentservices/eduviewer-frontend
- Owner: UH-StudentServices
- License: gpl-3.0
- Created: 2018-10-25T07:12:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-13T14:07:10.000Z (4 months ago)
- Last Synced: 2024-09-14T04:56:55.365Z (4 months ago)
- Language: JavaScript
- Size: 1.27 MB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eduviewer frontend (eduviewer-frontend)
This repository contains source code for the front end of the Eduviewer
## Dependencies
- Webpack 5.0
- css-loader 3.6.0 (loading breaks in 4.x version, fix later)
- Node 17+ (upgraded due to OpenSSL version change)
## Usage
### Development
To install the dependencies run:
`npm install`
`npm run dev` (HMR-enabled build)
The command starts `webpack-dev-server` on port 8080.
Development build uses public Eduviewer api `https://od.helsinki.fi/eduviewer/` as backend.
### Building
`npm run dist`
This will build and optimize all frontend assets under `dist` to be served statically by the deployment server.
Webpack will ouput following different build files inside the `dist` folder:
* eduviewer.var.js
* eduviewer.commonjs2.js
* eduviewer.umd.js
* eduviewer.amd.js
### How to use
Eduviewer frontend can be embedded to any web page using the following `div` tag:
```html
```
All attributes are optional.
* `lang` defaults to `fi`, other valid values are: `sv` & `en`
* `academic-year` defaults to the current academic year
* Example `acedemic-year` exact values: `hy-lv-68`, `hy-lv-69`.
* If `module-code` or `degree-program-id` is set, embedded app won't show select for Degree Program
* If `module-code` or `degree-program-id` is set `only-selected-academic-year` determines visibility of academic year dropdown
* `hide-selections` hides the whole selection section, including academic year dropdown and select all switch
* `only-selected-academic-year` hides academic year dropdown if exists and is not explicitly set to false
* `selected-academic-year-only` is a fallback value for React-components
* `hide-accordion` hides the root module accordion, showing only the accordion content
* `internal-course-links` sets course links as internal, removing the arrow marking an external link
* `module-code` or `degree-program-id` is the code of degree program set in Sisu. Valid examples: `KH10_001`, `MH30_004`
* If `header` isn't set, Eduviewer page won't have a h2 header on top of selects
* `disable-global-style` disables usage of uh-living-styleguide in eduviewer. Use this only if embedding app already uses uh-living-styleguide.
You'll also need to include the following `script` tag at the end of your page's `body` tag:
```html
```
# Create secrets from ssl
The stage is QA or PROD. This makes it possible to have different ssl files for different stages.
The "keys" ssl.crt and ssl.key become file names since these are mounted as files.
They must match what is specified in nginx.conf.template.
Also the path in nginx.conf.template must match the path specified in the deployments pod specs volume mount.
```
# or delete + create if it already exists or apply if you make a secret manifest.
oc create secret generic ssl-secret-$STAGE \
--from-file=TLS_KEY=./ssl.key \
--from-file=TLS_CERTIFICATE=./ssl.crt \
--from-file=TLS_CA_CERTIFICATE=./ssl_ca.crt
```
## License
GPL-3.0