README

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