README

   1 Ce document a pour but d'introduire le projet Euphorik, de décrire\r
   2 sa strucure et son utilisation au niveau du développement et de son\r
   3 utilisation.\r
   4 \r
   5 \r
   6 == Description ==\r
   7 Euphorik est un site web communautaire développé en Erlang pour le serveur Yaws et utilisant la base de données Mnesia.\r
   8 Il utilise massivement le javascript et l'AJAX coté client.\r
   9 \r
  10 == Installation ==\r
  11 L'installation de Yaws et sa configuration ainsi que l'initialisation de la base de données\r
  12 est décrit dans le fichier /doc/installation.txt.\r
  13 \r
  14 \r
  15 == Dossiers / Fichiers ==\r
  16  /index.html\r
  17    La page principale du site. Elle est statique.\r
  18 \r
  19  /mise_en_prod.rb\r
  20    Script permettant la mise en production du site.\r
  21    \r
  22  /BD\r
  23    Contient les fichiers lié à la base de données, initialement vide.\r
  24    \r
  25  /css\r
  26    Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin.\r
  27    \r
  28  /css/common.css\r
  29    La feuille de style commune à tous les skins.\r
  30    \r
  31  /doc\r
  32    Contient tous les documents de conception (fonctionnel, technique, etc.).\r
  33    \r
  34  /img\r
  35    Contient les images du site avec un séparation des images propres à chaque skin.\r
  36    Certaines images sont issues de document de conception se trouvant dans /doc/graphiques.\r
  37    \r
  38  /js\r
  39    Contient tous les scripts JavaScript. Il existe un script général à Euphorik : euphorik.js ainsi qu'un script par page : page*.js\r
  40    \r
  41  /lightbox\r
  42    Lib JavaScript permettant d'afficher des images sous la forme de pop-up modaux.\r
  43    \r
  44  /modules\r
  45    Contient la partie serveur.\r
  46    \r
  47  /modules/Makefile\r
  48    Règle de compilation des modules du serveur.\r
  49    \r
  50  /modules/ebin\r
  51    Contient les modules compilées, initialement vide.\r
  52    \r
  53  /module/erl\r
  54    Contient le code sources des différents modules Erlang.\r
  55    \r
  56  /modules/include\r
  57    Contient certaines définitions (headers).\r
  58    \r
  59  /pages\r
  60    Contient certaines pages XHTML qui seront chargée via AJAX.\r
  61    \r
  62  /sessions\r
  63    Contient différentes sessions de travail pour le développement avec Scite.\r
  64    \r
  65  /tool\r
  66    Contient des outils diverses permettant l'aide au développement ou la mise en production.\r
  67    \r
  68  /tool/jsmin.rb\r
  69    Permet la minification du javascript utilisé lors de la mise en production\r
  70    \r
  71