[github/shaarli/Shaarli.git] / doc / md / 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
	assets/
	    ├── common/                # Assets shared by multiple themes
	        ├── ...
        ├── default/               # Assets for the default template, before compilation
            ├── fonts/                  # Font files
            ├── img/                    # Images used by the default theme
            ├── js/                     # JavaScript files in ES6 syntax
            ├── scss/                   # SASS files
        └── vintage/               # Assets for the vintage template, before compilation
            └── ...
    COPYING          # Shaarli license
    inc/             # static assets and 3rd party libraries
        └── rain.tpl.class.php     # RainTPL templating library
    images/          # Images and icons used in Shaarli
    data/            # data storage: bookmark database, configuration, logs, banlist...
        ├── config.json.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.
    tpl/             # RainTPL templates for Shaarli. They are used to build the pages.
        ├── default/               # Default Shaarli theme
            ├── fonts/                  # Font files
            ├── img/                    # Images
            ├── js/                     # JavaScript files compiled by Babel and compatible with all browsers
            ├── css/                    # CSS files compiled with SASS
        └── vintage/               # Legacy Shaarli theme
            └── ...
    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.
    vendor/          # Third-party dependencies. This directory is created by Composer
```
Commit	Line	Data
	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	assets/
	22	├── common/ # Assets shared by multiple themes
	23	├── ...
	24	├── default/ # Assets for the default template, before compilation
	25	├── fonts/ # Font files
	26	├── img/ # Images used by the default theme
	27	├── js/ # JavaScript files in ES6 syntax
	28	├── scss/ # SASS files
	29	└── vintage/ # Assets for the vintage template, before compilation
	30	└── ...
	31	COPYING # Shaarli license
	32	inc/ # static assets and 3rd party libraries
	33	└── rain.tpl.class.php # RainTPL templating library
	34	images/ # Images and icons used in Shaarli
	35	data/ # data storage: bookmark database, configuration, logs, banlist...
	36	├── config.json.php # Shaarli configuration (login, password, timezone, title...)
	37	├── datastore.php # Your link database (compressed).
	38	├── ipban.php # IP address ban system data
	39	├── lastupdatecheck.txt # Update check timestamp file
	40	└── log.txt # login/IPban log.
	41	tpl/ # RainTPL templates for Shaarli. They are used to build the pages.
	42	├── default/ # Default Shaarli theme
	43	├── fonts/ # Font files
	44	├── img/ # Images
	45	├── js/ # JavaScript files compiled by Babel and compatible with all browsers
	46	├── css/ # CSS files compiled with SASS
	47	└── vintage/ # Legacy Shaarli theme
	48	└── ...
	49	cache/ # thumbnails cache
	50	# This directory is automatically created. You can erase it anytime you want.
	51	tmp/ # Temporary directory for compiled RainTPL templates.
	52	# This directory is automatically created. You can erase it anytime you want.
	53	vendor/ # Third-party dependencies. This directory is created by Composer
	54	```