[github/shaarli/Shaarli.git] / doc / Directory-structure.md

#Directory structure
Here is the directory structure of Shaarli and the purpose of the different files:

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