WebApp Digital Student Card

This web application provides a digital student card system, allowing students to access and manage their digital identification within an educational institution.

Description

The Digital Student Card WebApp is a modern, Vue.js-based application that offers a user-friendly interface for students to view and manage their digital student IDs. It integrates with a backend API to handle data processing and storage.

Configuration

Before running the application, you need to set up two configuration files:

1. config.ini (Backend)

Create a config.ini file in the root directory of this application with the following structure:

[general]
url = "http://your-backend-url"
debug = true

[database]
host = "your-db-host"
name = "your-db-name"
user = "your-db-username"
pass = "your-db-password"

[google]
issuer_id = 1234567890

[apple]
team_id = elanev
organization_name= elan e.V.
pass_type_identifier = de.elanev.app.pass
p12_password = 1234567890

[oidc]
provider_url = https://your-keycloak-url/realms/your-realm
client_id = client-id
client_secret = client-secret
redirect_url = /backend.php/oidc (it has to be relative path to general.url)
is_dev = false || true (when testing locally or https cannot be provided)

NOTE: you can use the config.ini.dist file as a template. Copy it to config.ini and fill in the required values.

Adjust the values according to your environment.

2. config.js (Frontend)

Create a config.js file in the src/ directory with the following content:

export default {
   apiUrl: 'http://your-backend-api-url/backend.php/'
}

Replace 'http://your-backend-api-url' with the actual URL of your backend API.

Installation

1. Clone the repository
2. Install backend dependencies:

   composer install
   

3. Install frontend dependencies:

   npm install
   

License

This project is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later).

See the LICENSE file for details or visit https://www.gnu.org/licenses/agpl-3.0.html

Authors

• Till Glöggler - gloeggler@elan-ev.de
• Farbod Zamani - zamani@elan-ev.de

About ELAN e.V.

This library is developed and maintained by elan e.V. - a non-profit organization dedicated to advancing digital education and e-learning solutions.

Copyright

Copyright © 2025 ELAN e.V.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

Support

For issues, questions, or contributions, please contact elan e.V. or visit https://elan-ev.de