From c23f4e1043f097b173c189833f02a5e797581466 Mon Sep 17 00:00:00 2001
From: BIRK Renaud <renaud.birk@imt-atlantique.net>
Date: Sun, 9 Mar 2025 11:55:05 +0100
Subject: [PATCH] doc: Google Drive integration documentation

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 227a8e1..6962981 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,12 @@ Back-end part for the Archi project.
 
 First, download this repository and unzip it to the folder of your choice.
 
+If you have Git client, you can also use the following command:
+
+```bash
+git clone https://gitlab.imt-atlantique.fr/FIL-A3-2024/ue-proj/archi-back.git
+```
+
 You will have to download Python [here](https://www.python.org/downloads) and install it on your computer.
 
 **Note: if the installer asks you to install pip package manager, say yes or check the box.**
@@ -48,6 +54,30 @@ chmod +x ./run.sh && ./run.sh
 Then, launch the front-end part with the instructions available
 [here](https://gitlab.imt-atlantique.fr/FIL-A3-2024/ue-proj/archi-front).
 
+## Google Drive integration (optional)
+
+If you want your results to be uploaded on Google Drive, you should configure a
+Google service account and a Google Drive folder shared with this account so it
+can upload your artworks.
+
+Follow these steps (as Google Cloud Console is dense, you can click link for each step):
+
+1. Visit [Google Cloud Console](https://console.cloud.google.com/).
+2. [Create a new project](https://console.cloud.google.com/projectcreate) and
+   give it a name.
+3. [Enable Google Drive API](https://console.cloud.google.com/marketplace/product/google/drive.googleapis.com)
+   for your project.
+4. [Create a service account](https://console.cloud.google.com/iam-admin/serviceaccounts/create)
+   for your project and just give it a name (copy its email and keep it in a notepad before clicking "OK").
+5. Click on the newly created account inside the list, click on "Keys" tab,
+   then on "Add key" button and "Create key". Check that "JSON" is selected and click "OK".
+6. Your key should have been downloaded. Rename it to "service_account.json".
+7. Copy the key inside the root folder of the project (archi-back).
+8. Create a new folder into [Google Drive](https://drive.google.com).
+9. Share this folder with the email of your service account (step 4, you can also find it [here](https://console.cloud.google.com/iam-admin/serviceaccounts)).
+10. Report the identifier of your Google Drive folder in `.env` file after `drive_folder_id=`.
+11. Your back-end should now be linked to your Google Drive account.
+
 ## Authors
 
 Renaud Birk and Anas Yakoubov
-- 
GitLab