euphorik.ch

h1. Folder structure

This page describes the most folder and file of the repository.

h2. Folders / Files

*/COPYING*

The license.

*/VERSION*

The current version. This string is copied in some places when the scripts in @/tools@ are executed.

*/index.yaws*

The web site entry point. 

*/var*

Containes the persisted data. Must have the read/write permissions for the _yaws_ user.

*/var/BD*

Contains the data base. Empty at the begining.

*/var/BD/backups*

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.

*/var/images/*

Contient les images récupéré depuis des url postés dans le chat. (_auto-hosting_ des images).

*/styles*

Contient les styles sous la forme de fichier _css_ et d'images. Chaque style est contenu dans un dossier numéroté, ce dossier contient un fichier 'infos.txt' donnant une description du style. Voir les styles existants pour plus d'informations.

*/doc*

Contient la documentation (fonctionnel, technique, etc.). Une grande partie de la doc à migré sur le "wiki":http://dev.euphorik.ch/wiki/euk .

*/img*

Contient les images du site communes à tous les styles.

Certaines images sont issues de document de conception se trouvant dans /doc/graphiques.

*/js*

Contient tous les scripts JavaScript utilisé par le navigateur client.

*/modules*

Contient la partie serveur.

*/modules/Makefile*

Règle de compilation des modules du serveur.

*/modules/ebin*

Contient les modules compilées, initialement vide.

*/module/erl*

Contient le code sources des différents modules Erlang.

*/modules/include*

Contient certaines définitions Erlang (headers).

*/pages*

Contient certaines pages XHTML qui seront chargée via AJAX.

*/sessions*

Contient différentes sessions de travail pour le développement avec Scite.

*/tools*

Contient des outils diverses permettant l'aide au développement ou la mise en production.

*/tools/tools.js*

Regoupe un ensemble d'outils permettant :

* La mise en production

* La vérification des fichiers JavaScript à l'aide de 'jslint.js'

* La mise à jour du numéro de version dans les sources à partir de /VERSION

Voir "tools.js --help"

*/tools/jsmin.js*

Permet la minification du javascript. Utilisé lors de la mise en production.

*/tools/start_tv.erl*

Permet de démarrer tv (_tuple viewer_) permettant d'accéder aux données de la BD à l'aide d'un GUI.

*/tools/update_server.erl*

Script exécuté sur le serveur lors de la mise en production, il demande le rechargement des modules et lance le processus de mise à jour de la BD.

*/tools/start_yaws.sh*

Script shell permettant de lancer Yaws, utilisé uniquement pour le développement et la pré-production. Il faut s'assurer que Yaws n'est pas déjà démarré comme daemon avec d'exécuter ce script.

*/tools/yaws.conf*

La configuration utilisé lors du développement et de la pré-production. Utilisé par start_yaws.sh.