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