epfl-SDP / android

A repository for the CS-306 Software Development Project class at EPFL.
MIT License
13 stars 2 forks source link

Pawnies – AR Chess

Maintainability Test Coverage

🎨 Figma mockups 🎨

🎬 See a demo on YouTube 🎬

Team

Name Email
Lars Barmettler lars.barmettler@epfl.ch
Matthieu Burguburu matthieu.burguburu@epfl.ch
Chau Ying Kot chau.kot@epfl.ch
Fouad Mahmoud fouad.mahmoud@epfl.ch
Alexandre Piveteau alexandre.piveteau@epfl.ch
Mohamed Badr Taddist mohamed.taddist@epfl.ch

Setup

This project depends on a specific release of the Jacoco library, which has been updated to provide coverage support for Jetpack Compose. This release is available on GitHub, and requires the use of the GitHub Apache Maven Package Repository. Therefore, you are required to add the following to your ~/.gradle/gradle.properties file to access the Maven package.

githubJacocoUsername=YourGitHubUsername
# Requires at least the read:packages scope.
githubJacocoPassword=YourGitHubPersonalAccessToken

As this project uses Google Firebase, you will also need to provide your own google-services.json.

This file can be generated from the Firebase Console (Pawnies Project -> Project Settings -> Your apps -> SDK setup and configuration -> google-services.json).

It must be placed at ./mobile/google-services.json

Architecture and organization overview

This project uses Jetpack Compose and is written in Kotlin. The main packages are organized as follows :

Assets sources

This section gathers different assets' sources used in our project :