ApplETS / Notre-Dame-v3

Projet Notre-Dame

This project is the placeholder for the third version of ÉTSMobile, a mobile which application that is currently available for Android and iOS. ÉTSMobile is the main gateway between the user and the École de technologie supérieure (ÉTS) on mobile devices. ÉTSMobile is an open-source project and is developped by members of the student club ApplETS. It offers:

• Access to evaluation grades
• Access to the student's schedules
• And many more...

Note: This guide is also available in: Français

🤖 Android Application

• Language: Kotlin

• Minimum SDK Version: 21

• Architecture

  Getting started

• Download and install the latest version of Android Studio

• Clone the project

git clone https://github.com/ApplETS/Notre-Dame.git

• Open the entire project in Android Studio

🍎 iOS Application

• Language: Swift version: 5
• Minimum SDK Version: 12.x

Getting started

• Download and install the latest version of Xcode
• Clone the project

git clone https://github.com/ApplETS/Notre-Dame.git

• Navigate inside the directory to reach the Podfile

cd Notre-Dame/ios/ETSMobile

• Install the Cocoapods declared inside the Podfile by running the command:

pod install

• A .xcworkspace file will be generated. You must use this file to open the project.

Build the project

Run the following command after each modification into the shared module:

gradlew packForXCode

Then you can build the application in XCode

🤖 / 🍎 Kotlin Multiplatform Project

The projet is migrating towards Kotlin Multiplatform.

👕 Ktlint Gradle

The project uses Ktlint Gradle, a wrapper over ktlint. It's a linter and a formatter for Kotlin code. In order to ensure that the code is well formatted, the CI runs the following command:

$ ./gradlew ktlintCheck

🤔 Question or issue?

Check out the FAQ (in French), open an issue or send an email to [email protected].

⚖️ License

This projet is licensed under the Apache License V2.0. See the LICENSE file for more info.