]> git.p6c8.net - jirafeau_mojo42.git/blob - NEWCOMER.txt
Translated using Weblate (Slovak)
[jirafeau_mojo42.git] / NEWCOMER.txt
1 Hi,
2
3 This document is only made for newcomers in Jirafeau who are digging into
4 the code.
5
6 Here is a little explaination of Jirafeau's arboresence in a simplified
7 view only to show the most importants files and their role.
8
9 .
10 ├── admin.php : adminitration interface, also permits to download files
11 ├── f.php : permits to download files or show the download page
12 ├── index.php : only provide a html/javascript client to interact with API
13 ├── script.php : API interface and it's html documentation
14 ├── install.php : installation script
15 ├── tos.php : terms of use the user may edit
16 ├── lib
17 │   ├── config.local.php : user's parameters
18 │   ├── config.original.php : default parameters with their documentation
19 │   ├── functions_*.js : javascript functions for html/javascript client
20 │   ├── functions.php : core functions and tools of jirafeau
21 │   ├── locales : langage folder, contain all langage files
22 │   └── template
23 │   ├── footer.php
24 │   └── header.php
25 ├── media : folder containing all skins
26 └── var-xxxxxxx : folder containing all data
27 ├── async : chunks of uploaded files
28 ├── files : all files that has been successfully uploaded
29 └── links : all links pointing to files with meta-informations
30
31 Coding style:
32
33 - PHP function keywords are alone on a line
34 - Braces "{" must are put in a new line
35 - Files must be in UTF-8 (without BOM)
36 - Uses LF (\n) for end of lines
37
38 The whole project is not clean about that, feel free to fix :)
39

patrick-canterino.de