MOD maj TODO
[euphorik.git] / 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 \r
17  /COPYING\r
18    La licence complète de euphorik.\r
19 \r
20 /VERSION\r
21    La version courante. Cette chaine est copiée à certains endroit des sources lors de l'execution du script "/tools/copie_num_version.rb"\r
22 \r
23  /index.yaws\r
24    La page principale du site. Elle est interprétée par le server HTTP Yaws et possède un petite partie dynamique.\r
25    \r
26  /BD\r
27    Contient les fichiers de la base de données, initialement vide.\r
28    \r
29  /BD/backups\r
30    Contient les backups de la base de données. A chaque changement de version de la base un backup est effectué, il est nommé "backup<num>" ou <num> est le numéro de version.\r
31    \r
32  /css\r
33    Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin.\r
34       \r
35  /doc\r
36    Contient la documentation (fonctionnel, technique, etc.).\r
37    \r
38  /img\r
39    Contient les images du site avec un séparation des images propres à chaque skin.\r
40    Certaines images sont issues de document de conception se trouvant dans /doc/graphiques.\r
41    \r
42  /js\r
43    Contient tous les scripts JavaScript. Il existe un script général à Euphorik : euphorik.js ainsi qu'un script par page : page*.js\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 Erlang (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  /tools\r
67    Contient des outils diverses permettant l'aide au développement ou la mise en production.\r
68    \r
69  /tools/copie_num_version.rb\r
70    Copie le contenu de /VERSION à différents endroits des sources, entre autre dans /pages/about.html\r
71    \r
72  /tools/jsmin.rb\r
73    Permet la minification du javascript utilisé lors de la mise en production.\r
74    \r
75  /tools/mise_en_prod.rb\r
76    Script permettant la mise en production du site.\r
77    \r
78  /tools/mise_en_prod.erl\r
79    Script Erlang exécuté sur le serveur lors de la mise en prod et effectuant des opérations tel que le rechargement des modules et le déclanchement de la mise à jour de la BD.\r
80    \r
81  /tools/start_yaws.sh\r
82    Script shell permettant de lancer Yaws, utilisé uniquement pour le développement. Il faut s'assuré que Yaws n'est pas déjà démarré comme daemon avec d'exécuter ce script.\r
83