refactor(readme): move exemples into separate files

Author: Lilianbazantay

README.md

@@ -44,58 +44,12 @@ The system is composed of three main parts:
 
 ### Installation
 
- - **Step 1**: Go to back and a create a \`config.toml\` file. Fill it with:
+ - **Step 1**: Go to back and a create a \`config.toml\` file. Fill it based on the data in exemples/exemple_config. In the provider section, replace the client_id and client_secret with your client_id and client_secret. Repeat for every provider. (They can be found in back/app/routes)
 
-[security]
-jwt_secret = "hello_world_3301@083280948390"
-
-[db]
-uri="sqlite+aiosqlite:///app.db"
-
-[providers]
-
-[providers.discord]
-client_id = id_exemple #1418965246885761106
-client_secret = secret_example #"JgGHjCxByc56UweRxbS978hWq9tpRbs4"
-
-[providers.github]
-\# ...
-
-In the providers, replace the client_id and client_secret with your client_id and client_secret. Repeat for every provider. (They can be found in back/app/routes)
-
-- **Step 2**: Go to front/android and create a \`gradle.properties\` file. Fill it with those informations:
-
-\# Project-wide Gradle settings.
-
-\# IDE (e.g. Android Studio) users:
-\# Gradle settings configured through the IDE *will override*
-\# any settings specified in this file.
-
-\# For more details on how to configure your build environment visit
-\# http://www.gradle.org/docs/current/userguide/build_environment.html
-
-\# Specifies the JVM arguments used for the daemon process.
-\# The setting is particularly useful for tweaking memory settings.
-org.gradle.jvmargs=-Xmx1536m
-
-\# When configured, Gradle will run in incubating parallel mode.
-\# This option should only be used with decoupled projects. More details, visit
-\# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
-\# org.gradle.parallel=true
-
-\# AndroidX package structure to make it clearer which packages are bundled with the
-\# Android operating system, and which are packaged with your app's APK
-\# https://developer.android.com/topic/libraries/support-library/androidx-rn
-android.useAndroidX=true
-RELEASE_STORE_FILE=/build/apk_key.jks
-RELEASE_STORE_PASSWORD=xxxxxx
-RELEASE_KEY_ALIAS=alias
-RELEASE_KEY_PASSWORD=xxxxxx
-
-Replace both of the "xxxxxx" with an actual password. That password need to be at least 6 characters long.
+- **Step 2**: Go to front/android and create a \`gradle.properties\` file. Fill it with the informations in exemples/exemple_gradle. Fill `RELEASE_STORE_PASSWORD` and `RELEASE_KEY_PASSWORD` with your own password. The two must have an identical one.
 
 - **Step 3**: In your terminal run `keytool -genkey -v -keystore apk_key.jks -keyalg RSA -keysize 2048 -validity 10000 -alias alias;`.
-It will ask for a keystore password, put the one you chose for the first step. It will follow by asking more information; those information don't need to be necesarilly true.
+It will ask for a keystore password, put the one you chose for the second step. It will follow by asking more information; those information don't need to be necesarilly true.
 Enter 'y' to confirm the datas you entered.
 
 - **Step 4**: run `docker build -t test -f android/Dockerfile . && docker run test:latest`.

exemples/exemple_config

@@ -0,0 +1,14 @@
+[security]
+jwt_secret = "hello_world_3301@083280948390"
+
+[db]
+uri="sqlite+aiosqlite:///app.db"
+
+[providers]
+
+[providers.discord]
+client_id = id_exemple #1418965246885761106
+client_secret = secret_example #"JgGHjCxByc56UweRxbS978hWq9tpRbs4"
+
+[providers.github]
+\# ...

exemples/exemple_gradle

@@ -0,0 +1,26 @@
+# Project-wide Gradle settings.
+
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx1536m
+
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+# org.gradle.parallel=true
+
+# AndroidX package structure to make it clearer which packages are bundled with the
+# Android operating system, and which are packaged with your app's APK
+# https://developer.android.com/topic/libraries/support-library/androidx-rn
+android.useAndroidX=true
+RELEASE_STORE_FILE=/build/apk_key.jks
+RELEASE_STORE_PASSWORD=xxxxxx
+RELEASE_KEY_ALIAS=alias
+RELEASE_KEY_PASSWORD=xxxxxx