IACUBUS is an mobile app which is based on open source project - ILIAS Pegasus. The app is running on Android or iOS and integrate functions of the ILIAS learning management system. For example viewing courses or personal news. It's main focus is to make files offline available to read them while offline.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
In order to use the App your ILIAS needs to be configured first. You need 2 Plugins (also Open Source) to make your ILIAS ready for the App:
Follow the instructions here: https://github.com/DEEP-eAcademy/PegasusHelper
The following tools are needed to build and deploy the app.
This project requires:
- Node 22.22
- Java 17
- Gradle 8.14
Install xcode over the apple app store.
Install Android Studio from google. https://developer.android.com/studio/index.html
Check here: https://docs.mapbox.com/help/how-mapbox-works/access-tokens/
A few additional tools are needed to run the app on an iOS device or emulator.
Install the development cli tools with
xcode-select --installInstall ios-sim which is used to fire up the iOS emulator.
npm install -g ios-simInstall ios-deploy which is used to deploy apps on a device.
npm install -g ios-deployInstall Android Studio from google. https://developer.android.com/studio/index.html
Install the latest Android SDK with the Android Studio Android SDK manager. Add the root of your Android SDK to the environment variable $ANDROID_HOME.
Clone the project to your workspace.
git clone https://github.com/DEEP-eAcademy/IACUBUS.git
cd IACUBUSChange into the cloned project and install all dependencies. This could take several minutes.
npm installCopy and edit the template of server.config.json.template and add the parameters for your ILIAS installation.
Save you configurationfile as server.config.json in branding/common/config.
Add you Installation id to the config.json file in your brand (eg. branding/brands/vanilla/config.json).
Copy and edit the template of .env.exmaple and add your Mapbox key. Add your key and save your environementfile as .env in the root directory.
MAPBOX_API_KEY="AddYourKeyHere"
PRODUCTION="true"
npm run setbrand -- --brand="IACUBUS"or
Choose your brand, following the README.md in the branding folder.
Install the both platforms.
npx ionic cordova prepare ios
npx ionic cordova prepare androidThe iOS app can be build with the following command.
npx ionic cordova build iosThe Android can be build with the same command.
npx ionic cordova build androidThe iOS app can be build and run in simulator with the Xcode app.
The Android can be build and run in emulator in Android Studio.
The linter can be run as shown bellow.
npm run tslintA lot of old code does not comply with the new code style rules checked by tslint, which result in a lot of warnings.
The unit tests can be run with the command shown bellow.
npm run karma:singlerunIf karma should keep running after the tests use the following command.
npm run karmaThe iOS app can be build with the following command.
npx ionic cordova build ios --prod --releaseOpen your Xcode Workspace (the YourAppName.xcworkspace in ./platforms/ios) and set Certifacates, your Team ID, set the iOS Deployment Target to 14.0 (in CordovaLib->Build Settings) and Release it to the AppStore.
Check here for information about Certificates: https://developer.apple.com/support/certificates/
And Check the ionic docs: https://ionicframework.com/docs/deployment/app-store
As soon as you have all your profiles create an Archive in Xcode -> Product -> Archive and upload it to the Appstore.
npx ionic cordova build android --prod --releaseCreate a key, sign your application and upload it following the ionic guide: https://ionicframework.com/docs/deployment/play-store
- Cordova - Is powering the app.
- Ionic - To build a responsive UI.
- Typescript - Helps maintaining large code bases and catch type issues early.
We use SemVer for versioning. For the versions available, see the releases on this repository.
The app is based on OpenSource project ILIAS Pegasus by studer + raimann ag, (https://fluxlabs.ch). Currently the app is maintened by NATO DEEP eAcademy IACUBUS Team.
This project is licensed under the GNU GPLv3 License - see the LICENSE file for details.
TL;DR* Here's what the license entails:
1. Anyone can copy, modify and distribute this software.
2. You have to include the license and copyright notice with each and every distribution.
3. You can use this software privately.
4. You can use this software for commercial purposes.
5. If you dare build your business solely from this code, you risk open-sourcing the whole code base.
6. If you modify it, you have to indicate changes made to the code.
7. Any modifications of this code base MUST be distributed with the same license, GPLv3.
8. This software is provided without warranty.
9. The software author or license can not be held liable for any damages inflicted by the software.We would also like to thank all the authors of the plugins and libraries we used! Please check the package.json or run the command bellow to see a list of all the plugins and libraries.
npm la --depth 0Patch Zip traversal security error in file platforms/android/app/src/main/java/org/apache/cordova/Zip.java:124:
File f = new File(outputDirectory, compressedName);
String canonicalPath = f.getCanonicalPath();
if (!canonicalPath.startsWith(outputDirectory)) {
String errorMessage = "Zip traversal security error";
callbackContext.error(errorMessage);
Log.e(LOG_TAG, errorMessage);
return;
}