Skip to content
This repository has been archived by the owner on Feb 25, 2024. It is now read-only.

Commit

Permalink
Merge branch 'release/3.0.0' into 'master'
Browse files Browse the repository at this point in the history
Release/3.0.0

See merge request Apps/ILIAS-Pegasus!47
  • Loading branch information
Jonathan Gerber committed Jun 19, 2019
2 parents a9742c3 + 0d968b7 commit 57d5a09
Show file tree
Hide file tree
Showing 1,158 changed files with 86,337 additions and 12,056 deletions.
9 changes: 7 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ log.txt
*.map
*.sourcemaps
*.keystore
*.jks
*_config.json
.vscode/
npm-debug.log*
server.config.json

.idea/
.sourcemaps/
Expand All @@ -32,20 +34,23 @@ plugins/
plugins/android.json
plugins/ios.json
$RECYCLE.BIN/
src/assets/*
resources


bin/android-*-unsigned.apk
ch_studerraimann_ilias_offline.keystore
.DS_Store
Thumbs.db
UserInterfaceState.xcuserstate
www_back/
www/build
www/*
!www/.placeholder
bower_components
src/assets/config.json
branding/common/config/server.config.json
src/assets/testinstallation_config.json
build*.sh
iq_config.xml

bin
simulation
37 changes: 37 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,43 @@
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [3.0.0] – 2019-06-19

### Changed
- Synchronization revised
- User Interface completely revised
- File Handling revised
- Faster loading of metadata
- Live loading of metadata
- Favorites are offline available now

### Added
- Branding provider
- Branding folder
- Branded App files
- Tile Home screen
- Access to the repository (join courses)

## [2.0.2] – 2018-10-02

### Fixed
- OnBoarding ( A bug that caused certain Android smartphones, especially Huawei & Samsung, that couldn't Skip onboarding)
- Loading spinner

### Changed
- Updated GoogleMaps
- Updated DocumentHandler for iOS

### Added
- Support for Android Oreo
- Support for iOS 12
- User Information on intial Sync

## [2.0.1] – 2018-07-08
### Added
- OnBoarding
- Information concerning EU DSGVO / GDPR

## [2.0.0] – 2018-04-13
### Added
- Learnplace feature
Expand Down
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ ILIAS Pegasus is an app which is running on Android or iOS and integrate functio
of the ILIAS learn management system. For example viewing courses or personal news.
Furthermore it is possible to make files offline available to read them while offline.

[![Build status](https://dev.azure.com/studer-raimann/ILIAS-Pegasus/_apis/build/status/ILIAS-Pegasus-CI)](https://dev.azure.com/studer-raimann/ILIAS-Pegasus/_build/latest?definitionId=1)

## Getting Started
These instructions will get the ILIAS Pegasus app up and running.

Expand Down Expand Up @@ -52,24 +54,31 @@ Install the Java 8 SDK from oracle. Java 9 and 10 are not supported at the momen
<http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html>
Add the path to your java runtime to the $JAVA_HOME environment variable.

### Install
### Install Dependencies
Clone the project to your workspace.
Change into the cloned project and install all dependencies.
This could take several minutes.
```bash
npm install
```

### Configure your ILIAS Installation

Copy and edit the template of s[server.config.json.template](../blob/master/branding/common/config/server.config.json.template) and add the development 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)

### Install Brand
[Choose your brand, following the README.md in the branding folder.](../blob/master/branding/README.md)

### Install Platforms

Install the both platforms.
```bash
ionic cordova prepare
```

Copy and edit the template of config.json and add the development ILIAS
installation.
```bash
mv src/assets/config.json.template src/assets/config.json
```

### Debug Build

Expand Down Expand Up @@ -147,6 +156,21 @@ OUTPUT_DIR="./bin" \
./tools/build-android.sh
```

### Troubleshoting
#### Cordova Plugin GoogleMaps
In order to use Learnplaces (Lernorte) you need the google map plugin. Use Version 2.4.6.
If allready installed another version remove the plugin:
```bash
ionic cordova plugin remove cordova-plugin-googlemaps
```
Add it using your API Key:
```bash
ionic cordova plugin add [email protected] \
--variable API_KEY_FOR_ANDROID="YOUR API KEY ANDROID GOES HERE" \
--variable API_KEY_FOR_IOS= "YOUR API KEY IOS GOES HERE"
```


### Build With
* [Cordova](https://cordova.apache.org/) - Is powering the app.
* [Ionic](https://ionicframework.com/) - To build a responsive UI.
Expand Down
108 changes: 108 additions & 0 deletions branding/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
this directory contains the data that is customizable for the different brands of the pegasus-app

# usage

each brand is defined by a directory 'brands/[BRAND_NAME]'

in order to set the branding of the app, use the following command

npm run setbrand -- --brand=[BRAND_NAME] --platforms==[PLATFORMS]

where the flag 'platforms' is optional and may be set to 'ia', 'ai', 'i', 'a' or 'none'. accordingly, the script will add the (a)ndroid and (i)os platforms to the project. when set to 'none', the platforms are not altered in any way. the default value of the flag is 'ia'

the script './branding/set_brand.js' will set the customization and generate a log-file at './branding/set_brand.log'

# structure for each brand

the following structure of directories and files must be provided for each brand

* [BRAND_NAME]
* [BRAND_NAME]/assets
* [BRAND_NAME]/assets/stylesheets/theme.scss
* [BRAND_NAME]/resources
* [BRAND_NAME]/build.json
* [BRAND_NAME]/config.json

# config

the file '[BRAND_NAME]/config.json' contains information that is used by the hook-script './branding/set_brand.js'

__template__


```
{
"ilias_installation_ids": [],
"projectConfig": {
"id": "",
"name": "",
"description": ""
}
}
```

the array 'ilias_installation_ids' contains ids that correspond to ILIAS-installations, declared in './branding/common/config/server.config.json'

the strings 'id', 'name' and 'description' are used as the value for the fields 'widget/id', 'name' and 'description' in 'config.xml'

only the chosen entries will be available on the login-screen in the customized app, and the first id sets the default installation for the login

# languages

the basis all brands is set in './branding/common/i18n'

if brand-specific translations are needed, they can be defined in '[BRAND_NAME]/assets/i18n', where a file with the same name as the one that should be modified must be placed

__example usage__

* './branding/common/i18n/en.json'

```
{
"0" : "apple",
"1" : {
"2" : "juice"
}
}
```

* '[BRAND_NAME]/assets/i18n/en.json'

```
{
"1" : {
"2" : "pie"
},
"3" : "new"
}
```

* resulting './assets/i18n/en.json'

```
{
"0" : "apple",
1" : {
"2" : "pie"
},
"3" : "new"
}
```

# stylesheets and fonts

the file '[BRAND_NAME]/assets/stylesheets/theme.scss' is the only scss-file that will be imported by the app, it thus is responsible for all the styling

in addition, the variable '$ionicons-font-path' will be set to match the content of '[BRAND_NAME]/assets/fonts'

# icons and images

the directories '[BRAND_NAME]/assets/icon' and '[BRAND_NAME]/assets/img' must contain the assets that are used by the app

# resources

the directory '[BRAND_NAME]/resources' contains the splash screens and icons for android and ios, it will be placed at './resources'

# release builds

the file [BRAND_NAME]/build.json contains information that is used for IOS release builds
95 changes: 95 additions & 0 deletions branding/brands/fhaachen/assets/fonts/Raleway/OFL.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
Copyright (c) 2010, Matt McInerney ([email protected]),
Copyright (c) 2011, Pablo Impallari (www.impallari.com|[email protected]),
Copyright (c) 2011, Rodrigo Fuenzalida (www.rfuenzalida.com|[email protected]), with Reserved Font Name Raleway

This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL


-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------

PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.

The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.

DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.

"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).

"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).

"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.

"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.

PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:

1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.

2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.

3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.

4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.

5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.

TERMINATION
This license becomes null and void if any of the above conditions are
not met.

DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
32 changes: 32 additions & 0 deletions branding/brands/fhaachen/assets/fonts/Raleway/Raleway.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/* latin-ext */
@font-face {
font-family: 'Raleway';
font-style: normal;
font-weight: 400;
src: local('Raleway'), local('Raleway-Regular'), url("../assets/fonts/Raleway/Raleway-Regular.ttf") format('truetype');
unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-family: 'Raleway';
font-style: normal;
font-weight: 400;
src: local('Raleway'), local('Raleway-Regular'), url("../assets/fonts/Raleway/Raleway-Regular.ttf") format('truetype');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
/* latin-ext */
@font-face {
font-family: 'Raleway';
font-style: normal;
font-weight: 600;
src: local('Raleway SemiBold'), local('Raleway-SemiBold'), url("../assets/fonts/Raleway/Raleway-SemiBold.ttf") format('truetype');
unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-family: 'Raleway';
font-style: normal;
font-weight: 600;
src: local('Raleway SemiBold'), local('Raleway-SemiBold'), url("../assets/fonts/Raleway/Raleway-SemiBold.ttf") format('truetype');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
Binary file added branding/brands/fhaachen/assets/fonts/icomoon.eot
Binary file not shown.
Loading

0 comments on commit 57d5a09

Please sign in to comment.