UCL-INGI / StudUCLouvain

StudUCLouvain Application for UCLouvain students

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Stud.UCLouvain

Stud.UCLouvain is an application designed to accompany UCLouvain students in their daily life on campus.

Contributions are welcome for any good feature.

[WIP] Possible major update (+ migration to Ionic_v4) : https://github.com/BenJneB/StudUCLouvain_ionic-v4

Feel free to collaborate.

Anyone wishing to participate and/or propose new features should not hesitate to contact StudUCLouvain@uclouvain.be or directly make a pull-request on the repo concerned.

Join the chat at https://gitter.im/UCLCampus/Lobby

Prerequisites

node -v
 - should be >= 12.0.0
npm -v
 - should be >= 6.0.0

Getting Started

  • Clone this repository

  • Install Ionic, cordova

    $ npm install -g ionic cordova@^9
  • or update Ionic

    $ npm uninstall -g ionic cordova
    $ npm install -g ionic cordova@^9
  • Install node_modules

    $ npm install
  • Replace the values of "myapikeyforandroid" and "myapikeyforios" by the keys you created in the Google Console, in the file StudUCLouvain/config.xml

    <preference name="GOOGLE_MAPS_ANDROID_API_KEY" value="myapikeyforandroid"/>
    <plugin name="cordova-plugin-googlemaps">
      <variable name="API_KEY_FOR_ANDROID" value="myapikeyforandroid" />
      <variable name="API_KEY_FOR_IOS" value="myapikeyforios" />
    </plugin>
  • Replace the value of "myapikey" by your Javascript key in the file StudUCLouvain/src/app/variables-config.ts

Build

$ ionic cordova build <platform>
$ ionic cordova build <platform> --prod
$ ionic cordova build <platform> --prod --release

Run

Browser

$ ionic serve

Android/Other

  • Prepare the cordova build (If this does not work, skip this step and try again after the next step. If this does not work again, ignore and test without):
    $ cordova prepare
$ ionic cordova platform add <android/iOS>
$ ionic cordova run <android/iOS>

For iOS, a Mac device is mandatory.

Tests

Unit Tests : Karma

To run the unit tests

$ npm test

E2E Tests : Protractor

To run the E2E tests

$ ionic serve
$ npm run e2e

Features

Existing Features

Future Features

  • Display exam score

User Guide

Contribution

Contributions are welcome!

  • Report issues
  • Open pull request with improvements
  • Spread the word

Developper Guide

Contact

License

Stud.UCLouvain is available under the GNU/GPLv3 license. See the LICENSE file for more info.

About

StudUCLouvain Application for UCLouvain students

License:GNU General Public License v3.0


Languages

Language:TypeScript 59.9%Language:HTML 29.8%Language:CSS 8.5%Language:JavaScript 1.8%