-README - EUPHORIK\r
------------------\r
-\r
-Ce document a pour but d'introduire le projet Euphorik, de décrire\r
-sa strucure et son utilisation au niveau du développement et de son\r
+Ce document a pour but d'introduire le projet Euphorik, de décrire\r
+sa strucure et son utilisation au niveau du développement et de son\r
utilisation.\r
\r
\r
--- Description --\r
-Euphorik est un site web communautaire développer en Erlang pour le serveur Yaws et utilisant la base de données Mnesia.\r
+== Description ==\r
+Euphorik est un site web communautaire développé en Erlang pour le serveur Yaws et utilisant la base de données Mnesia.\r
+Il utilise massivement le javascript et l'AJAX coté client.\r
\r
+== Installation ==\r
+L'installation de Yaws et sa configuration ainsi que l'initialisation de la base de données\r
+est décrit dans le fichier /doc/installation.txt.\r
\r
--- Installation\r
-L'installation de Yaws et sa configuration ainsi que l'initialisation de la base de données\r
-est décrit dans le fichier /doc/installation.txt.\r
\r
+== Dossiers / Fichiers ==\r
\r
--- Dossiers / Fichiers --\r
-/index.html\r
- La page principale du site. Elle est statique.\r
+ /COPYING\r
+ La licence complète de euphorik.\r
\r
-/mise_en_prod.rb\r
- Script permettant la mise en production du site.\r
- \r
-/BD\r
- Contient les fichiers lié à la base de données, initialement vide.\r
- \r
-/css\r
- Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin.\r
- \r
-/css/common.css\r
- La feuille de style\r
+/VERSION\r
+ La version courante. Cette chaine est copiée à certains endroit des sources lors de l'execution du script "/tools/copie_num_version.rb"\r
+\r
+ /index.yaws\r
+ La page principale du site. Elle est interprétée par le server HTTP Yaws et possède un petite partie dynamique.\r
\r
-/doc\r
- Contient tous les documents de conception (fonctionnel, technique, etc.).\r
+ /BD\r
+ Contient les fichiers de la base de données, initialement vide.\r
\r
-/img\r
- Contient les images du site avec un séparation des images propres à chaque skin.\r
- Certaines images sont issues de document de conception se trouvant dans /doc/graphiques\r
+ /BD/backups\r
+ 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
\r
-/js\r
- Contient tous les scripts JavaScript. Il existe un script général à Euphorik : euphorik.js ainsi qu'un script par page : page*.js\r
+ /css\r
+ Contient les feuilles de style de chaque skin contenu dans un dossier représentant le numéro du skin.\r
+ \r
+ /doc\r
+ Contient la documentation (fonctionnel, technique, etc.).\r
\r
-/lightbox\r
- Lib JavaScript permettant d'afficher des images sous la forme de pop-up div.\r
+ /img\r
+ Contient les images du site avec un séparation des images propres à chaque skin.\r
+ Certaines images sont issues de document de conception se trouvant dans /doc/graphiques.\r
\r
-/modules\r
+ /js\r
+ Contient tous les scripts JavaScript. Il existe un script général à Euphorik : euphorik.js ainsi qu'un script par page : page*.js\r
+ \r
+ /modules\r
Contient la partie serveur.\r
\r
-/modules/Makefile\r
- Règle de compilation des modules du serveur.\r
+ /modules/Makefile\r
+ Règle de compilation des modules du serveur.\r
\r
-/modules/ebin\r
- Contient les modules compilées, initialement vide.\r
+ /modules/ebin\r
+ Contient les modules compilées, initialement vide.\r
\r
-/module/erl\r
- Contient le code sources des différents modules.\r
+ /module/erl\r
+ Contient le code sources des différents modules Erlang.\r
\r
-/modules/include\r
- Contient certaines définitions (headers).\r
+ /modules/include\r
+ Contient certaines définitions Erlang (headers).\r
\r
-/pages\r
- Contient certaines pages XHTML qui seront chargée via AJAX.\r
+ /pages\r
+ Contient certaines pages XHTML qui seront chargée via AJAX.\r
\r
-/sessions\r
- Contient différentes sessions de travail pour le développement avec Scite.\r
+ /sessions\r
+ Contient différentes sessions de travail pour le développement avec Scite.\r
\r
-\r
+ /tools\r
+ Contient des outils diverses permettant l'aide au développement ou la mise en production.\r
+ \r
+ /tools/tools.rb\r
+ Regoupe un ensemble d'outils permettant :\r
+ - La mise en production\r
+ - La vérification des fichiers JavaScript à l'aide de 'jslint.js'\r
+ - La mise à jour du numéro de version dans les sources à partir de /VERSION\r
+ Voir "tools.rb --help"\r
\r
-
\ No newline at end of file
+ /tools/jsmin.rb\r
+ Permet la minification du javascript utilisé lors de la mise en production.\r
+ \r
+ /tools/start_yaws.sh\r
+ 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
+
\ No newline at end of file
projects / euphorik.git / blobdiff