@@ -56,38 +56,48 @@ File Hierarchy System
5656
5757This is a brief description of GLPI main folders and files:
5858
59+ * |folder | `.devcontainer `
60+ * |folder | `.docker `
5961* |folder | `.tx `: Transifex configuration
62+ * |folder | `.github `: Github related setup (CI, builds, templates and so on)
6063* |folder | `ajax `
6164
6265 * |phpfile | `*.php `: Ajax components
6366
64- * |folder | `files ` Files written by GLPI or plugins (documents, session files, log files, ...)
65- * |folder | `front `
67+ * |folder | `bin `
6668
67- * |phpfile | `*.php `: Front components (all displayed pages)
69+ * |phpfile | `console `: GLPI console executable
6870
6971* |folder | `config ` (only populated once installed)
7072
7173 * |phpfile | `config_db.php `: Database configuration file
7274 * |phpfile | `local_define.php `: Optional file to override some constants definitions (see ``inc/define.php ``)
75+ * |file | `glpicrypt.key `: Crypt key used to encrypt/decrypt database stored passwords
7376
7477* |folder | `css `
7578
76- * |folder | `... `: CSS stylesheets
77- * |file | `*.css `: CSS stylesheets
79+ * |folder | `... `: SCSS stylesheets
80+ * |file | `*.css `: SCSS stylesheets
81+
82+ * |folder | `dependency_injection `: dependency injection setup
83+ * |folder | `files ` Files written by GLPI or plugins (documents, session files, log files, ...)
84+ * |folder | `front `
85+
86+ * |phpfile | `*.php `: Front components (all displayed pages)
7887
7988* |folder | `inc `
8089
81- * |phpfile | `*.php `: Classes, functions and definitions
90+ * |phpfile | `*.php `: Functions and definitions
8291
8392* |folder | `install `
8493
94+ * |folder | `migrations `: Update files
8595 * |folder | `mysql `: MariaDB/MySQL schemas
86- * |phpfile | `*.php `: upgrades scripts and installer
96+ * |phpfile | `*.php `: upgrades scripts, installer, data to inject after installation
8797
8898* |folder | `js `
8999
90- * |file | `*.js `: Javascript files
100+ * |file | `*.js `: Javascript source files
91101
92102* |folder | `lib `
93103
@@ -99,19 +109,41 @@ This is a brief description of GLPI main folders and files:
99109 * |file | `*.po `: Gettext's translations
100110 * |file | `*.mo `: Gettext's compiled translations
101111
112+ * |folder | `marketplace `:
113+
114+ * |folder | `... `: where all plugins from marketplace land
115+
102116* |folder | `plugins `:
103117
104- * |folder | `... `: where all plugins lends
118+ * |folder | `... `: where all plugins land
119+
120+ * |folder | `public `:
121+
122+ * |folder | `... `: images, compiled stylesheets and javascripts
123+ * |phpfile | `index.php `: application main entry point
124+
125+
126+ * |folder | `resources `: Various resources
127+ * |folder | `routes `: Routing setup
128+ * |folder | `src `
129+
130+ * |folder | `... `: Classes
131+ * |phpfile | `*.php `: Classes
105132
133+ * |folder | `stubs `
134+ * |folder | `templates `: Twig templates files
106135* |folder | `tests `: unit and integration tests
107136* |folder | `tools `: a bunch of tools
137+ * |folder | `version `: Current version for internal use
108138* |folder | `vendor `: third party libs installed from composer (see composer.json below)
109139* |file | `.gitignore `: Git ignore list
110140* |file | `apirest.md `: REST API documentation
111141* |file | `CHANGELOG.md `: Changes
112- * |file | `composer.json `: Definition of third party libraries (`see composer website <https://getcomposer.org >`_)
142+ * |file | `LICENSE `: License file
143+ * |file | `composer.json `: Definition of PHP third party libraries (`see composer <https://getcomposer.org >`_)
144+ * |file | `package.json `: Definition of javascript third party libraries (`see NPM <https://www.npmjs.com/ >`_)
113145* |file | `phpunit.xml.dist `: unit testing configuration file
114- * |file | `README.md `: well... a README ;)
146+ * |file | `... `: various files to setup builds, lint and so on
115147
116148
117149
0 commit comments