Improve documentation

- Add clear and clean SPDX-formatted header in sources - Add file of AUTHORS - Add documentation and JSON files for mocks Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
CovidTrackerFr · Jan 2, 2022 · 3726ed3 · 3726ed3
1 parent c027f37
commit 3726ed3
Show file tree

Hide file tree

Showing 93 changed files with 30,375 additions and 315 deletions.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -0,0 +1,12 @@
+# Authors
+
+## From A to Z
+
+* Nathan FALLET <contact(at)nathanfallet(dot)me>
+* Yannick HEINRICH <yannick(dot)heinrich(at)gmail(dot)com>
+* Paul JEANNOT <paul(dot)jeannot95(at)gmail(dot)com>
+* Pierre-Yves LAPERSONNE <dev(at)pylapersonne(dot)info>
+* Corentin MEDINA <corentin(dot)medina(at)epsi(dot)fr>
+* Michaël NASS <michael(dot)nass(at)free(dot)fr>
+* Guillaume ROZIER <28guillaume28(at)gmail(dot)com>
+* Victor SARDA <victor(dot)sarda(at)icloud(dot)com>
diff --git a/FAQ.md b/FAQ.md
@@ -0,0 +1,59 @@
+# FAQ
+
+## Mettre en place un serveur local pour jouer avec des données
+
+Pour tester l'application ainsi que les évolutions et corrections faites dessus, il est possible d'utiliser un serveur web HTTP en local pour remplacer le serveur de production.
+Quelques étapes ci-dessous :
+
+### Configuration
+
+1. Installer un serveur web HTTP sur une machine
+2. Récupérer l'adresse IP locale de cette machine, admettons ici **w.x.y.z**
+3. Dans le fichier _remote-configuration.plist_, remplacer la valeur associée à la clé **url_base** par **http://w.x.y.z**. Il faudra aussi certainement renseigner le port sur lequel tourne le serveur (par exemple **8888**)
+4. Dans le dossier web pour ce serveur, placer un fichier _index.html_ avec par exemple le code ci-dessous:
+```HTML
+<!doctype html>
+<html lang="fr">
+    <head>
+        <title>Vite Ma Dose (localhost)</title>
+    </head>
+    <body>
+        <h1>Youpi !</h1>
+    </body>
+</html>
+```
+5. Via un navigateur web, saisir l'URL du site web, ici **http://w.x.y.z:8888**. Un page avec le texte _Youpi !_ doit être affichée ; sinon il y a vraisemblablement un problème de configuration de votre serveur web.
+6. Créer dans le dossier web un sous-dossier nommé _vitemadose_, au même niveau que le fichier _index.html_
+
+### Récupération préliminaire des données (à la main)
+
+Admettons maintenant que vous désirez tester avec des données de Caen dans le Calvados (département 14) :
+
+1. Aller sur [le site web de production](https://vitemadose.covidtracker.fr/)
+2. Ouvrir la console web du navigateur que vous utilisez
+2. Saisir _14000_ et sélectionner _14000 - Caen_
+3. Récupérer (via un onglet supposément nommé _Network_ par exemple) le contenu des fichiers _14.json_ qui aura les infos des centres de vaccination, ainsi que le fichier _creneaux-quotidiens.json_. S'assurer de prendre celui du bon département (URL de la forme _https://vitemadose.gitlab.io/vitemadose/14/creneaux-quotidiens.json_). Récupérer aussi le fichier _stats.json_ et le fichier _departements.json_ (par exemple via l'URL _https://vitemadose.gitlab.io/vitemadose/departements.json_)
+4. Dans le sous-dossier _vitemadose_ du dossier web, mettre les fichiers _14.json_, _stats.json_ et _departements.json_
+5. Dans le sous-dossier _vitemadose_ du dossier web, créér un sous-dossier _14_ et y placer le fichier _creneaux-quotidiens.json_
+
+Maintenant, il ne reste plus qu'à compiler le projet _Xcode_ sur un appareil et lancer l'application. L'appareil doit être sur le même réseau local que la machine ayant le serveur web.
+
+Astuce pour savoir si on affiche les données locales ou non : modifier le contenu des fichiers JSON avec des éléments exotiques comme :
+- dans _stats.json_, pour l'objet **tout_departement**, remplacer la valeur du champ "disponibles" par des nombres reconnaissables
+- dans le fichier _14.json_, changer le nom d'un centre de vaccination
+
+Si toutefois, malgré tout ceci, vous pensez récupérer des données depuis le site web de production, il est possible que la configuration à distance (via _Firebase_)  ait pris la main et écrasé la configuration par défaut renseignée dans le fichier _remote-config.plist_. Auquel cas, y aller plus brutalement en remplaçant la valeur retournée par la propriété calculée `baseUrl` dans l'extension de `RemoteConfiguration` par l'adresse IP du serveur local, comme :
+
+```swift
+    var baseUrl: String {
+        //return configuration.configValue(forKey: "url_base").stringValue!
+        return "http://w.x.y.z:8888"
+    }
+```
+
+Enfin, la recherche de créneaux Vite Ma Dose se base aussi sur les départements voisins du département concerné. Ainsi, pour le Calvados (14), les données d'autres départements sont récupérées, à savoir : l'Orne (61), la Manche (50) et l'Eure (27). Il faut donc alors faire la récupération des fichiers JSON pour ces 3 autres départements.
+
+### Récupération préliminaire des données (via le dossier dédié)
+
+La chose étant un peu fastidieuse, vous pouvez vous contenter de prendre les données fournies dans le dossier _bouchons_ et les mettre dans votre dossier de serveur web.
+
diff --git a/ViteMaDose/AppDelegate.swift b/ViteMaDose/AppDelegate.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  AppDelegate.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 07/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Classes/DoubledString.swift b/ViteMaDose/Helpers/Classes/DoubledString.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  DoubledString.swift
-//  ViteMaDose
-//
-//  Created by Pierre-Yves Lapersonne on 01/01/2022.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import Foundation

diff --git a/ViteMaDose/Helpers/Classes/Logger.swift b/ViteMaDose/Helpers/Classes/Logger.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  Logger.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 09/05/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import Foundation

diff --git a/ViteMaDose/Helpers/Extensions/Array+Commons.swift b/ViteMaDose/Helpers/Extensions/Array+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  Array+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 03/05/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import Foundation

diff --git a/ViteMaDose/Helpers/Extensions/Bool+Commons.swift b/ViteMaDose/Helpers/Extensions/Bool+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  Bool+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 04/12/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import Foundation

diff --git a/ViteMaDose/Helpers/Extensions/Collection+Commons.swift b/ViteMaDose/Helpers/Extensions/Collection+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  Collection+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 07/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import Foundation

diff --git a/ViteMaDose/Helpers/Extensions/Data+Commons.swift b/ViteMaDose/Helpers/Extensions/Data+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  Data+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 07/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import Foundation

diff --git a/ViteMaDose/Helpers/Extensions/NSMutableAttributedString+Commons.swift b/ViteMaDose/Helpers/Extensions/NSMutableAttributedString+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  NSMutableAttributedString+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 09/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/NSTextAttachment+Commons.swift b/ViteMaDose/Helpers/Extensions/NSTextAttachment+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  NSTextAttachment+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 14/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/Storyboard+Common.swift b/ViteMaDose/Helpers/Extensions/Storyboard+Common.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  Storyboard+Common.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 07/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/String+Commons.swift b/ViteMaDose/Helpers/Extensions/String+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  String+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 23/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import Foundation

diff --git a/ViteMaDose/Helpers/Extensions/UICollectionView+Commons.swift b/ViteMaDose/Helpers/Extensions/UICollectionView+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  UICollectionView+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 10/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/UIColor+VideMaDose.swift b/ViteMaDose/Helpers/Extensions/UIColor+VideMaDose.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  UIColor+VideMaDose.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 08/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/UIContentSizeCategory+Commons.swift b/ViteMaDose/Helpers/Extensions/UIContentSizeCategory+Commons.swift
@@ -1,5 +1,5 @@
 // Software Name: vitemadose-ios
-// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
 // SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
 // This software is distributed under the GPL-3.0-or-later license.

diff --git a/ViteMaDose/Helpers/Extensions/UIFont+Commons.swift b/ViteMaDose/Helpers/Extensions/UIFont+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  UIFont+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 11/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/UIFont+TextSizes.swift b/ViteMaDose/Helpers/Extensions/UIFont+TextSizes.swift
@@ -1,10 +1,9 @@
 // Software Name: vitemadose-ios
 // SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
-// SPDX-License-Identifier: GPL-3.0
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-// This software is distributed under the GNU General Public License v3.0 only.
+// This software is distributed under the GPL-3.0-or-later license.
 //
-// Author: Pierre-Yves LAPERSONNE <dev(at)pylapersonne(dot)info> et al.
 
 import Foundation
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/UIImage+Commons.swift b/ViteMaDose/Helpers/Extensions/UIImage+Commons.swift
@@ -1,10 +1,9 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  UIImage+Commons.swift
-//  ViteMaDose
+// This software is distributed under the GPL-3.0-or-later license.
 //
-//  Created by Victor Sarda on 11/04/2021.
-//
-
 import UIKit
 
 extension UIImage {

diff --git a/ViteMaDose/Helpers/Extensions/UITableView+Commons.swift b/ViteMaDose/Helpers/Extensions/UITableView+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  UITableView+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 07/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/UIView+Common.swift b/ViteMaDose/Helpers/Extensions/UIView+Common.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  UIView+Common.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 07/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/UIViewController+ErrorDisplayable.swift b/ViteMaDose/Helpers/Extensions/UIViewController+ErrorDisplayable.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  UIViewController+ErrorDisplayable.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 18/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/UIViewControllerController+Commons.swift b/ViteMaDose/Helpers/Extensions/UIViewControllerController+Commons.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  UIViewController+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 09/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Extensions/URL+Commons.swift b/ViteMaDose/Helpers/Extensions/URL+Commons.swift
@@ -1,9 +1,9 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  URL+Commons.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 07/04/2021.
-//
+// This software is distributed under the GPL-3.0-or-later license.
+//w
 
 import Foundation
 import UIKit

diff --git a/ViteMaDose/Helpers/Protocols/ClassNameProtocol.swift b/ViteMaDose/Helpers/Protocols/ClassNameProtocol.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  ClassNameProtocol.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 07/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import Foundation

diff --git a/ViteMaDose/Helpers/Protocols/ErrorDisplayable.swift b/ViteMaDose/Helpers/Protocols/ErrorDisplayable.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  ErrorDisplayable.swift
-//  ViteMaDose
-//
-//  Created by Victor Sarda on 18/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import UIKit

diff --git a/ViteMaDose/Helpers/Utils/AppAnalytics.swift b/ViteMaDose/Helpers/Utils/AppAnalytics.swift
@@ -1,8 +1,8 @@
+// Software Name: vitemadose-ios
+// SPDX-FileCopyrightText: Copyright (c) 2021 CovidTracker.fr
+// SPDX-License-Identifier: GNU General Public License v3.0 or later
 //
-//  Logger.swift
-//  ViteMaDose
-//
-//  Created by Paul on 15/04/2021.
+// This software is distributed under the GPL-3.0-or-later license.
 //
 
 import Foundation