doc/md/Directory-structure.md

   1 ## Directory structure
   2
   3 Here is the directory structure of Shaarli and the purpose of the different files:
   4
   5 ```bash
   6         index.php        # Main program
   7         application/     # Shaarli classes
   8                 ├── LinkDB.php
   9
  10         ...
  11
  12                 └── Utils.php
  13         tests/           # Shaarli unitary & functional tests
  14                 ├── LinkDBTest.php
  15
  16         ...
  17
  18                 ├── utils    # utilities to ease testing
  19                 │   └── ReferenceLinkDB.php
  20                 └── UtilsTest.php
  21     COPYING          # Shaarli license
  22     inc/             # static assets and 3rd party libraries
  23         ├── awesomplete.*          # tags autocompletion library
  24         ├── blazy.*                # picture wall lazy image loading library
  25         ├── shaarli.css, reset.css # Shaarli stylesheet.
  26         ├── qr.*                   # qr code generation library
  27         └── rain.tpl.class.php     # RainTPL templating library
  28     images/          # Images and icons used in Shaarli
  29     data/            # data storage: bookmark database, configuration, logs, banlist...
  30         ├── config.json.php        # Shaarli configuration (login, password, timezone, title...)
  31         ├── datastore.php          # Your link database (compressed).
  32         ├── ipban.php              # IP address ban system data
  33         ├── lastupdatecheck.txt    # Update check timestamp file
  34         └── log.txt                # login/IPban log.
  35     tpl/             # RainTPL templates for Shaarli. They are used to build the pages.
  36     cache/           # thumbnails cache
  37                      # This directory is automatically created. You can erase it anytime you want.
  38     tmp/             # Temporary directory for compiled RainTPL templates.
  39                      # This directory is automatically created. You can erase it anytime you want.
  40     vendor/          # Third-party dependencies. This directory is created by Composer
  41 ```