EzStudies

Ease your studies

English version below

Deprecated

This project is deprecated and won't be updated anymore. Since graduating from CY Cergy Paris Université and starting a full-time job, I no longer have the time to maintain this project. And even if I had, I will soon lose access to the university's API, which will make the development impossible on my side.

If you wish to maintain it, feel free to fork it or to contact me at [email protected] to contribute directly to this repo.

However, the application is still working and can be used as is (Android and Web), until potential breaking changes on the university's side.

Introduction

Ce projet une évolution de EzStudies et a pour but de simplifier le quotidien des étudiants de CY Cergy Paris Université.

Comparé à la version précédente, cette version comporte de nombreuses différences. La principale est que celle-ci est une application Flutter, donc réalisée en Dart, et qu'elle est compatible Android, iOS et Web.

Fonctionnalités

• Consultation de son emploi du temps via l'API de l'ENT de l'université, avec stockage hors ligne
• Consultation de l'emploi du temps des autres étudiants de l'université N'est plus possible à cause d'un changement du côté de l'API de l'ENT
• Connexion à l'application avec ses identifiants de l'ENT de l'université
• Communications sécurisées avec une API personnalisée pour réduire l'utilisation du processeur de l'appareil
• Stockage sécurisé des identifiants de l'ENT pour communiquer avec l'API
• Gestion de l'emploi du temps, comprenant ajout, modification et suppression de cours
• Gestion des devoirs, comprenant ajout, modification et suppression de devoirs
• Notifications pour les cours et/ou les devoirs
• Interface inspirée de Material You, avec thème clair et thème sombre
• Application en Anglais et en Français
• Et plus encore

Sécurité

Les identifiants de l'utilisateur sont stockés et utilisés de façon sécurisée.

Tout d'abord, les identifiants de l'utilisateur sont chiffrés avant d'être stockés dans l'appareil.

Puis, ceux-ci sont communiqués à l'API via une requête HTTPS POST.

L'API se charge de déchiffrer ces identifiants avant de les communiquer à l'API de CYU.

L'application ne fonctionne donc uniquement si sa clé de chiffrement est identique à celle de l'API.

Téléchargement

Vous pouvez télécharger l'application dans la section Releases.

La version Web est accessible à cette adresse.

iOS

Il n'y aura pas de release pour iOS car Apple ne permet pas d'installer d'applications gratuitement.

Vous pouvez en revanche compiler vous-même l'application pour votre iPhone si vous avez un Mac récent et héberger vous-même l'API Web (indispensable au fonctionnement de l'application).

API

Le code source de l'API personnalisée, utilisée pour faire fonctionner cette application, se trouve dans le dossier EzStudies-Flutter/web/api.

L'API est incluse dans ce projet pour faciliter le déploiement de l'application Web.

Compilation

Prérequis :

• Android Studio (avec les plugins requis pour Flutter)
• Flutter SDK
• FireBase CLI (optionnel)

Note : L'application est liée à FireBase dans l'unique but de profiter de FireBase Crashlytics. FireBase est donc optionnel au fonctionnement de l'application.

Pour compiler l'application, il faut d'abord :

• Lier l'application à FireBase ou supprimer l'implémentation de FireBase
• Renseigner les variables d'environnement dans le fichier /EzStudies-Flutter/.env

SERVER_URL = "xxx"  
CIPHER_KEY = "xxx"  

où SERVER_URL est l'URL de l'API personnalisée et CIPHER_KEY est la clé de chiffrement de 32 caractères utilisée pour chiffrer et déchiffrer les identifiants de l'ENT

• Renseigner cette même clé de chiffrement dans le fichier /EzStudies-Flutter/web/api/include/key

xxx  

Puis :

• Générer les textes de l'application

flutter gen-l10n

Note : il faut utiliser cette commande après toutes modifications des fichiers app_en.arb ou app_fr.arb.

• Générer les variables d'environnement

flutter pub run build_runner build --delete-conflicting-outputs

Note : il faut utiliser cette commande après toutes modifications du fichier .env.

Enfin, l'application pourra être compilée et exécutée de façon habituelle.

EzStudies (English)

Ease your studies

Introduction

This project is an evolution of EzStudies and aims to simplify the daily lives of students of CY Cergy Paris Université.

Compared to the previous version, this one has many differences. The main difference is that this is a Flutter app, written in Dart, and that it's compatible with Android, iOS and Web.

Features

• View your own agenda using the API of the ENT of the university, with offline storage
• View the agenda of other students of the university No longer possible due to a change on the side of the API of the ENT
• Log into the app with the credentials from the ENT of the university
• Secured communications with a customised API to reduce the processor usage of the device
• Secured storage of credentials from the ENT of the university used to communicate with the custom API
• Manage your agenda, including adding, editing and deleting courses
• Manage your homeworks, including adding, editing and deleting homeworks
• Notifications for courses and/or homeworks
• Material You inspired interface, with light theme and dark theme
• Application in English and French
• And more

Security

User's credentials are stored and used securely.

First, user credentials are encrypted before being stored in the device.

Then, these are communicated to the API via an HTTPS POST request.

The API takes care of decrypting these credentials before communicating them to the API of CYU.

The application therefore only works if its cipher key is identical to that of the API.

Download

You can download the application in the Releases section.

The Web version is available at this address.

iOS

There will be no release for iOS because Apple does not allow installing apps for free.

You can however compile the application yourself for your iPhone if you have a recent Mac and host the Web API yourself (required to make the application work).

API

The source code of the custom API, used to make this app work, is located on the EzStudies-Flutter/web/api folder.

The API is included in this project ease the deployment of the Web app.

Compilation

Prerequisites :

• Android Studio (with plugins required for Flutter)
• Flutter SDK
• FireBase CLI (optional)

Note : The app is linked to FireBase for the sole purpose of using FireBase Crashlytics. So FireBase optional to make the app work.

Before compiling the app, you have to :

• Link the app to FireBase or delete the implementation of FireBase
• Type in environment variables in the /EzStudies-Flutter/.env file

SERVER_URL = "xxx"  
CIPHER_KEY = "xxx"  

where SERVER_URL is the URL of the custom API and CIPHER_KEY a 32 characters cipher key used to encrypt and decrypt the credentials of the ENT

• Type in the same key in the /EzStudies-Flutter/web/api/include/key file

xxx  

Then :

• Generate texts of the app

flutter gen-l10n

Note : you have to use this command each time you change the app_en.arb or app_fr.arb files.

• Generate environment variables

flutter pub run build_runner build --delete-conflicting-outputs

Note : you have to use this command each time you change the .env file.

Finally, the app can be compiled and executed as usual.