/StudUCLouvain

StudUCLouvain Application for student

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

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.

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

Prerequisites

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

Getting Started

  • Clone this repository

  • Install Ionic, cordova

    $ npm install -g ionic cordova
  • or update Ionic

    $ npm uninstall -g ionic cordova
    $ npm install -g ionic cordova
  • Install node_modules

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

    <plugin name="cordova-plugin-googlemaps" spec="~1.4.0">
      <variable name="API_KEY_FOR_ANDROID" value="myapikeyforandroid" />
      <variable name="API_KEY_FOR_IOS" value="myapikeyforios" />
    </plugin>
  • or install it with

    $ ionic cordova plugin add https://github.com/mapsplugin/cordova-plugin-googlemaps --variable API_KEY_FOR_ANDROID="YOUR_ANDROID_API_KEY_HERE" --variable API_KEY_FOR_IOS="YOUR_IOS_API_KEY_HERE"
  • Replace the value of "myapikey" by your Javascript key in the file StudUCLouvain/src/app/variables-config.ts

Run

Browser

$ ionic serve

Android

  • 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
$ ionic cordova run android

iOS

  • 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 ios
$ ionic cordova build ios

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.