Documentation Technique

 EPITECH Documentation Technique Liny Frédéric Rousseau EIP 2013 Ce document dresse la documentation technique du serveur de l’application Liny, application de rencontres amoureuses par géolocalisation. Ce document à pour but d’aider les développeurs a prendre et suivre le projet Liny. 1 Informations sur le projet Groupe :
Nom du projet :
Contact :
Type de document :
Version :
Référence :
Statut du document :
Liny
Liny
http://liny.info
Documentation technique
1.2
2013_TD3_FR_liny
Livrée
Diffusion Personne Frédéric Rousseau Email [email protected] Julien Seban Olivier Thierry Thomas Ringuede Yoann Jaspar [email protected] [email protected] [email protected] [email protected] Rôle Graphiste, Développeur (Dév.) Black Berry et Windows Phone7 Dév. Android, chargé market/communication Dév. iPhone et serveur Dév. Android, chargé market/communication Dév. Site web et serveur Historique des révisions du document Version 1.0 1.1 1.2 1.3 Date Nom 21/02/12 Frédéric Rousseau 23/03/12 Frédéric Rousseau 29/03/12 Frédéric Rousseau 18/05/12 Besoin de préciser ? Description Création du document Corrections en vu du TA2 Corrections diverses Corrections en vu du TA3 2 Table des matières Résumé .................................................................................................................................. 4 Serveur .................................................................................................................................. 5 Application cliente ............................................................................................................ 7 Website .......................................................................................................................................... 7 WP7 ................................................................................................................................................. 8 Black Berry ................................................................................................................................... 8 iPhone ............................................................................................................................................ 8 Android .......................................................................................................................................... 8 3 Résumé Le document sépare documentation serveur et cliente. La documentation du serveur est générée via Rdoc. La documentation, du website comme des applications phonegap, est générée via Jsdoc. 4 Serveur Le serveur de Web Services est développé en Ruby on Rails. Il reçoit des requêtes GET-­‐POST/REST et répond en JSON. La documentation est auto-­‐générée avec le code via le software Rdoc. Liste des classes : •
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
OpenID OpenID::Store OpenID::Store::Mongo OpenID::Store::Mongo::Association OpenID::Store::Mongo::Nonce Password Password::Invalid ApplicationController ApplicationHelper Coordinate Environement EnvironementController EnvironementHelper FilterRange Filters FiltersController FiltersHelper HairComponent HomeController HomeHelper Housing Interest InterestComponent InterestsController InterestsHelper Language MMModel Message MessagesController MessagesHelper Notification NotificationsController NotificationsHelper Physique PhysiqueController PhysiqueHelper 5 •
•
•
•
•
•
•
•
•
PostsController Profile ProfileController ProfileHelper SessionsController SessionsHelper User UsersController UsersHelper Une version plus détaillée et explicative est visualisable sur le Rdoc : Documentation technique du serveur Liny Le code source du serveur est disponible sur : https://[email protected]/_oli/liny.git 6 Application cliente Website Le website est une IHM codé en html5, css3 et Javascript dissocié du serveur. La communication avec les webservices du serveur est gérée en Javascript. La documentation technique est générée via Jsdoc. Liste des classes : •
Communication •
Communication.User •
Map •
RoundedCornerSquare •
User •
User.Location •
User.Personality •
User.Personality.Interests •
User.Personality.Jobs •
User.Personality.Languages •
User.Personality.Rates •
User.Personality.Studies •
User.Physique •
User.Physique.Colors •
User.Physique.Rates •
User.Physique.Sizes •
User.Profile Une version plus détaillée et explicative est visualisable sur le JSdoc: Documentation technique du website Le code source du website est disponible sur : 7 https://[email protected]/zougi/liny_webapp.git WP7 L’application WP7 est générée par PhoneGap. Ce dernier la génère à partir des sources du website. Black Berry Utilise PhoneGap. (cf WP7) iPhone Développé en Natif Android Développé en Natif 8