Version iOS du projet Kilobits

Outils

• Version 8.2.1 de XCode
• Swift 3
• L'outil de gestion de Frameworks Cocoapods (Lancer 'pod install' dans le répertoire du projet à chaque nouveau Framework ajouté).
• Le Framework SwiftyJSON pour récupérer facilement le JSON (classe JSON)
• Le Framework Alamofire pour faciliter les requêtes HTTP (récupération des codes status des réponses, des données etc.)
• Le Framework SpeedLog pour faciliter le debugging (permet de supprimer tous les print en mode Release -> plus rapide)
• La base de donnée liée au projet (ici)
• L'utilitaire Jazzy pour générer la documentation du projet

Installation du dépôt

1. Clônage du dépôt avec intégration Git
2. Ouvrir XCode et choisir d'ouvrir un projet SCM déjà existant.
3. Entrer l'addresse Github du dépôt : "git@github.com:ClubInfoPolytechLille/Kilobits_iOS.git".
4. Lorsque les options de connection s'affichent, choisir "SSH Keys" et s'assurer d'avoir configuré auparavant une clé SSH sur l'ordinateur (cf ici pour un tuto).
5. Installer Cocoapods sur le Mac en tapant "sudo gem install cocoapods" dans un terminal.
6. Fermer le projet et à partir de maintenant, toujours ouvrir le Workspace du projet plutôt que le projet lui-même. Pour cela, se rendre avec le terminal dans le dossier du projet (là ou se trouve le fichier Kilobits_iOS.xcworkspace) et lancer la commande suivante : "open Kilobits_iOS.xcworkspace". C'est nécessaire car sinon le projet n'arrivera pas à faire le lien avec les Frameworks installés.
7. Installer Jazzy en tapant dans un terminal "sudo gem install jazzy". Pour générer une nouvelle version de la documentation, aller dans le répertoire du projet et taper "jazzy --min-acl private".

Documentation

• Pour générer une nouvelle version de la documentation, aller dans le répertoire du projet et éxécuter la commande "./updateDocs.sh"
• La documentation se trouve dans le dossier /docs.

Tutoriels Swift

• Tutoriel pas à pas d'une appli Swift
• Guide du Langage Swift
• Tutoriel SwiftyJSON
• SwiftyJSON Documentation
• Tutoriel Alamofire & SwiftyJSON
• SpeedLog Documentation
• Mots-clés pour la documentation