Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digital-blueprint/cabinet-app
Student record management application
https://github.com/digital-blueprint/cabinet-app
dbp-relay digital-blueprint
Last synced: about 2 months ago
JSON representation
Student record management application
- Host: GitHub
- URL: https://github.com/digital-blueprint/cabinet-app
- Owner: digital-blueprint
- License: lgpl-2.1
- Created: 2024-02-15T10:25:11.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:21:57.000Z (about 2 months ago)
- Last Synced: 2024-10-29T09:48:49.542Z (about 2 months ago)
- Topics: dbp-relay, digital-blueprint
- Language: JavaScript
- Homepage:
- Size: 1.46 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cabinet Application
[GitHub Repository](https://github.com/digital-blueprint/cabinet-app) |
[npmjs package](https://www.npmjs.com/package/@digital-blueprint/cabinet-app) |
[Unpkg CDN](https://unpkg.com/browse/@digital-blueprint/cabinet-app/) |
[Cabinet Bundle](https://github.com/digital-blueprint/relay-cabinet-bundle)
[](https://github.com/digital-blueprint/cabinet-app/actions/workflows/build-test-publish.yml)
This is an application for managing student records.
## Prerequisites
- You need the [API server](https://gitlab.tugraz.at/dbp/relay/dbp-relay-server-template) running
- You need the [DBP Cabinet Bundle](https://gitlab.tugraz.at/dbp/dual-delivery/relay-cabinet-bundle)
## Local development
```bash
# get the source
git clone [email protected]:digital-blueprint/cabinet-app.git
cd cabinet-app
git submodule update --init
# install dependencies
npm install
# constantly build dist/bundle.js and run a local web-server on port 8001
npm run watch
# constantly build dist/bundle.js and run a local web-server on port 8001 using a custom assets directory assets_custom/
npm run watch-custom
# run tests
npm test
```
Jump to , and you should get a Single Sign On login page.
By default, the application is built using the assets in `assets/`. However, custom assets can also be used to build the application. The custom assets can be added to the directory `assets_custom/dbp-cabinet/assets/`. This allows developers to easily develop and build the application for different environments.
To use the Nextcloud functionality you need a running Nextcloud server with the
[webapppassword](https://gitlab.tugraz.at/dbp/nextcloud/webapppassword) Nextcloud app like this
[Nextcloud Development Environment](https://gitlab.tugraz.at/dbp/nextcloud/webapppassword/-/tree/master/docker).
## Use app via Docker
### docker-compose.yml
```yaml
version: '3'
services:
web:
image: ghcr.io/digital-blueprint/cabinet-app:latest
restart: always
ports:
- "8000:80"
```
## Using this app as pre-built package
### Install app
If you want to install the dbp cabinet app in a new folder `cabinet-app` with a path prefix `/` you can call:
```bash
npx @digital-blueprint/cli@latest install-app cabinet cabinet-app /
```
Afterward you can point your Apache web-server to `cabinet-app/public`.
Make sure you are allowing `.htaccess` files in your Apache configuration.
Also make sure to add all of your resources you are using (like your API and Keycloak servers) to the
`Content-Security-Policy` in your `cabinet-app/public/.htaccess`, so the browser allows access to those sites.
You can also use this app directly from the [Unpkg CDN](https://unpkg.com/browse/@digital-blueprint/cabinet-app/)
for example like this: [dbp-cabinet/index.html](https://github.com/digital-blueprint/cabinet-app/tree/main/examples/dbp-cabinet/index.html)
Note that you will need a Keycloak server along with a client id for the domain you are running this html on.
### Update app
If you want to update the dbp cabinet app in the current folder you can call:
```bash
npx @digital-blueprint/cli@latest update-app cabinet
```
## Using a single activity as pre-built package
You can also use a single activity directly from the [Unpkg CDN](https://unpkg.com/browse/@digital-blueprint/cabinet-app/)
for example the `dbp-qualified-cabinet-pdf-upload` activity to qualifiedly sign PDF documents like this:
[dbp-qualified-cabinet-pdf-upload/index.html](https://github.com/digital-blueprint/cabinet-app/tree/main/examples/dbp-qualified-cabinet-pdf-upload/index.html)
Note that you will need a Keycloak server along with a client id for the domain you are running this html on.
## Activities
This app has the following activities:
- `dbp-dd-activity`
- `dbp-qualified-signature-pdf-upload`
- `dbp-official-signature-pdf-upload`
You can find the documentation of these activities in the [qualified cabinet activities documentation](https://github.com/digital-blueprint/cabinet-app/tree/main/src).
## Adapt app
### Functionality
You can add multiple attributes to the `` tag.
| attribute name | value | Link to description |
|----------------|-------|-------------------------------------------------------------------------------------------------------------------------------------|
| `provider-root` | Boolean | [app-shell](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/main/packages/app-shell#attributes) |
| `lang` | String | [language-select](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/main/packages/language-select#attributes) |
| `entry-point-url` | String | [app-shell](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/main/packages/app-shell#attributes) |
| `keycloak-config` | Object | [app-shell](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/main/packages/app-shell#attributes) |
| `base-path` | String | [app-shell](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/main/packages/app-shell#attributes) |
| `src` | String | [app-shell](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/main/packages/app-shell#attributes) |
| `html-overrides` | String | [common](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/main/packages/common#overriding-slots-in-nested-web-components) |
| `themes` | Array | [theme-switcher](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/main/packages/theme-switcher#themes-attribute) |
| `darkModeThemeOverride` | String | [theme-switcher](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/main/packages/theme-switcher#themes-attribute) |
#### Mandatory attributes
If you are not using the `provider-root` attribute to "terminate" all provider attributes
you need to manually add these attributes so that the topic will work properly:
```html
```
### Design
For frontend design customizations, such as logo, colors, font, favicon, and more, take a look at the [theming documentation](https://dbp-demo.tugraz.at/dev-guide/frontend/theming/).
## "dbp-cabinet" slots
These are common slots for the app-shell. You can find the documentation of these slots in the [app-shell documentation](https://gitlab.tugraz.at/dbp/web-components/toolkit/-/tree/main/packages/app-shell).
For the app specific slots take a look at the [cabinet activities](https://github.com/digital-blueprint/cabinet-app/tree/main/src).