ILIAS Pegasus

ILIAS Pegasus is an app which is running on Android or iOS and integrate functions of the ILIAS learn management system. For example viewing courses or personal news. It's main focus is to make files offline available to read them while offline. Check https://ilias-pegasus.de for more information.

Getting Started

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.

Prerequisites

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 Pegasus App:

Follow the instructions here: https://github.com/fluxapps/PegasusHelper

The following tools are needed to build and deploy the app.

Ionic CLI:

npm install -g ionic

Cordova CLI:

npm install -g cordova

Xcode:

Install xcode over the apple app store.

Android Studio:

Install Android Studio from google. https://developer.android.com/studio/index.html

A MapBox (OpenStreetMap) API-Key

Check here: https://docs.mapbox.com/help/how-mapbox-works/access-tokens/

iOS Development

A few additional tools are needed to run the app on an iOS device or emulator.

Install the development cli tools with

xcode-select --install

Install ios-sim which is used to fire up the iOS emulator.

npm install -g ios-sim

Install ios-deploy which is used to deploy apps on a device.

npm install ios-deploy

Android Development

Install 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.

Install the Java SDK from oracle.

Clone the project

Clone the project to your workspace.

git clone https://github.com/studer-raimann/ILIAS-Pegasus.git
cd ILIAS-Pegasus

Install Dependencies

Change into the cloned project and install all dependencies. This could take several minutes.

npm install

Configure your ILIAS Installation

Copy 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).

Add you mapbox key to environement

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"

Install Brand

npm run setbrand -- --brand="vanilla"

or

Choose your brand, following the README.md in the branding folder.

Install Platforms

Install the both platforms.

npx ionic cordova prepare

Debug Build

The iOS app can be build with the following command.

npx ionic cordova build ios

The Android can be build with the same command.

npx ionic cordova build android

Run in Simulator/Emulator (with livereload and console output)

The iOS app can be build with the following command.

npx ionic cordova emulate ios -lcs

The Android can be build with the same command.

npx ionic cordova emulate android -lcs

Run the Tests

Lint

The linter can be run as shown bellow.

npm run tslint

A lot of old code does not comply with the new code style rules checked by tslint, which result in a lot of warnings.

Unit tests

The unit tests can be run with the command shown bellow.

npm run karma:singlerun

If karma should keep running after the tests use the following command.

npm run karma

Deployment

iOS

The iOS app can be build with the following command.

npx ionic cordova build ios  --prod

Open your Xcode Workspace (the YourAppName.xcworkspace in ILIAS-Pegasus/Platforms/ios) and set Certifacates, your Team ID 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.

Android

npx ionic cordova build android --prod --release

Create a key, sign your application and upload it following the ionic guide: https://ionicframework.com/docs/deployment/play-store

Build With

• Cordova - Is powering the app.
• Ionic - To build a responsive UI.
• Typescript - Helps maintaining large code bases and catch type issues early.

Versioning

We use SemVer for versioning. For the versions available, see the releases on this repository.

Authors

This is an OpenSource project by studer + raimann ag, (https://fluxlabs.ch)

[email protected]
https://ilias-pegasus.de

License

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.

Acknowledgments

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 0