public/traque
1
0
Fork 0
mirror of https://git.rezel.net/LudoTech/traque.git synced 2026-02-09 02:10:18 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Traque results and documentation

Browse Source
This commit is contained in:
Sebastien Riviere
2025-12-14 18:34:09 +01:00
parent 5f50e0c797
commit eb72a1e5da
15 changed files with 3044 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
traque-app/doc/apk_android.md
View File

@@ -2,15 +2,13 @@
An apk is an app file that can be installed on an android device without the need of google play store. This tutorial will explain the steps to create the apk of the current project and download it on an android device. Each step has precisions, however some of those precisions may not be suited for your device, don't hesitate to find help on the Internet or ask ChapGPT.
## Set up your environnement
This section will cover the set up of your environnement in order to have the tools to either send the apk of your app on your device or create a virtual android device.
### Tutorial
Follow this tutorial : https://reactnative.dev/docs/set-up-your-environment?os=linux&platform=android
Follow this [tutorial](https://reactnative.dev/docs/set-up-your-environment?os=linux&platform=android).
### Precisions
@@ -18,8 +16,6 @@ Follow this tutorial : https://reactnative.dev/docs/set-up-your-environment?os=l
* The Watchman installation isn't necessary.
* If you want to test your app on a physical android device, follow the next section.
## Create the android folder
This section will cover the creation of the android folder if it isn't created yet.
@@ -30,8 +26,6 @@ This section will cover the creation of the android folder if it isn't created y
* Run `npm i`
* Run `npx expo prebuild --platform android`
## Create and add the app key
This section will cover the creation of the app key which is required by google play store. You will need the `.keystore` file associated to the app. If no one in the team have created it yet follow *Tutorial Part A* then *Tutorial Part B*, else get the `.keystore` file, the storePassword, the keyAlias and the keyPassword, and follow *Tutorial Part B*.
@@ -45,9 +39,9 @@ This section will cover the creation of the app key which is required by google
* Go in the folder `traque-app/android/app/`.
* Here paste the `.keystore` file associated with your app.
* Modify the android bracket of the `traque-app/android/app/build.gradle` file as follows :
* Modify the android bracket of the `traque-app/android/app/build.gradle` file as follows :
```
```txt
android {
...
signingConfigs {
@@ -70,8 +64,6 @@ android {
}
```
## Create the apk
This section will cover the creation of the apk of the app that can be download and installed on any android device.
@@ -85,10 +77,12 @@ This section will cover the creation of the apk of the app that can be download
### Precisions
While running `./gradlew assembleRelease`, you can have this error :
```
```txt
Task :expo-modules-core:compileDebugKotlin FAILED
e: This version (1.5.15) of the Compose Compiler requires Kotlin version 1.9.25 but you appear to be using Kotlin version 1.9.24 which is not known to be compatible.
```
Follow these steps to fix it :
* In the `android/build.gradle` file, replace the line `classpath('org.jetbrains.kotlin:kotlin-gradle-plugin')` by `classpath('org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.25')`.
@@ -96,7 +90,7 @@ Follow these steps to fix it :
### Other precisions
If the build fail for obscure reasons, it may be usefull to delete entirely the `node_modules/` folder and recreate it by running `npm i`.
If problems persist, you may also delete entirely the `android/` folder and recreate it.
If the problem persist, you may also delete the `~/.gradle/caches/` folder.
If the problem persist, stop working on the project, you can't go against god's will.
If the build fail for obscure reasons, it may be usefull to delete entirely the `node_modules/` folder and recreate it by running `npm i`.
If problems persist, you may also delete entirely the `android/` folder and recreate it.
If the problem persist, you may also delete the `~/.gradle/caches/` folder.
If the problem persist, stop working on the project, you can't go against god's will.

18
traque-app/doc/dev_build_android.md
View File

@@ -1,8 +1,6 @@
# How to create a local developpement build with Expo
Expo go is great to start a React Native project with Expo but reaches its limits when background localisation or server notifications have to be implemented and tested. This tutorial will explain the steps to create the debug android app of the current project (ie developpement build) and download it on an android device. A similar process can be done to test the IOS app but it requires a Mac so this won't be covered in this tutorial. A virtual android device can be created with Android Studio (explained later) but the process to send the app on the virtual device isn't covered in this tutorial. Here is a link that may help you : https://youtu.be/cs-zgHjt5RQ?si=Fzxik7zreek07uC0. Each step has precisions, however some of those precisions may not be suited for your device, don't hesitate to find help on the Internet or ask ChapGPT.
Expo go is great to start a React Native project with Expo but reaches its limits when background localisation or server notifications have to be implemented and tested. This tutorial will explain the steps to create the debug android app of the current project (ie developpement build) and download it on an android device. A similar process can be done to test the IOS app but it requires a Mac so this won't be covered in this tutorial. A virtual android device can be created with Android Studio (explained later) but the process to send the app on the virtual device isn't covered in this tutorial. Here is a [youtube video](https://youtu.be/cs-zgHjt5RQ?si=Fzxik7zreek07uC0) that may help you. Each step has precisions, however some of those precisions may not be suited for your device, don't hesitate to find help on the Internet or ask ChapGPT.
## Set up your environnement
@@ -10,7 +8,7 @@ This section will cover the set up of your environnement in order to have the to
### Tutorial
Follow this tutorial : https://reactnative.dev/docs/set-up-your-environment?os=linux&platform=android
Follow this [tutorial](https://reactnative.dev/docs/set-up-your-environment?os=linux&platform=android).
### Precisions
@@ -18,23 +16,19 @@ Follow this tutorial : https://reactnative.dev/docs/set-up-your-environment?os=l
* The Watchman installation isn't necessary.
* If you want to test your app on a physical android device, follow the next section.
## Set up your physical android device
This section will cover the actions to perform on your device to be able to download the apk of the app.
### Tutorial
Follow the first section of this tutorial : https://reactnative.dev/docs/running-on-device?os=linux&platform=android
Follow the first section of this [tutorial](https://reactnative.dev/docs/running-on-device?os=linux&platform=android).
### Precisions
* In some devices, you may also enable the *install via USB* option.
* When your device is connected, keep in your mind that a pop up asking authorizations can appear on it.
## Build the native app
This section will cover the building of the app and the sending on your device.
@@ -50,17 +44,17 @@ This section will cover the building of the app and the sending on your device.
### Precisions
While running `npx expo run:android`, you can have this error :
```
```txt
Task :expo-modules-core:compileDebugKotlin FAILED
e: This version (1.5.15) of the Compose Compiler requires Kotlin version 1.9.25 but you appear to be using Kotlin version 1.9.24 which is not known to be compatible.
```
Follow these steps to fix it :
* In the `android/build.gradle` file, replace the line `classpath('org.jetbrains.kotlin:kotlin-gradle-plugin')` by `classpath('org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.25')`.
* In the `traque-app` folder, run `npx expo run:android` again.
## Run the app
This section will explain how to run the app. The process is really similar to the one to run the app on Expo go and can be done with your device on the same WI-FI network as your computer.