Skip to content

Structure

Pepe Fabra Valverde edited this page Jan 4, 2022 · 1 revision

The file structure

Folder Structure

The folder structure

📦screenshot
 ┣ 📂ci              # Continuous Integration
 ┣ 📂docs            # All the documentation
 ┃ ┗ 📂en            # All the documentation in english
 ┣ 📂logs            # All the logs
 ┣ 📂public          # All the public, visible and accessible resources
 ┣ 📂screenshots     # The screenshots generated, a temp, but necessary folder
 ┗ 📂src             # The logic
   ┣ 📂config        # Configuration files
   ┣ 📂driver        # Browser drivers
   ┣ 📂endpoints     # API endpoints logic
   ┗ 📂libs          # Utility libraries

Files

The folder structure with the files

📦screenshot
 ┣ 📂ci                                # Continuous Integration
 ┃ ┣ ...
 ┣ 📂docs                              # All the documentation
 ┃ ┗ 📂en                              # All the documentation in english
 ┃ ┃ ┣ 📜Api.md
 ┃ ┃ ┗ 📜Structure.md
 ┣ 📂logs                              # All the logs
 ┃ ┣ 📜log.txt
 ┃ ┗ 📜screenshots.log
 ┣ 📂public                            # All the public, visible and accessible resources
 ┃ ┣ 📜.htaccess
 ┃ ┣ 📜api.php
 ┃ ┣ 📜form.php
 ┃ ┣ 📜index.php
 ┃ ┗ 📜legal.php
 ┣ 📂screenshots                       # The screenshots generated, a temp, but necessary folder
 ┃ ┣ 📜\*.png
 ┗ 📂src                               # The logic
 ┃ ┣ 📂config                          # Configuration files
 ┃ ┃ ┃ ┗ 📜constants.php
 ┃ ┣ 📂driver                          # Browser drivers
 ┃ ┃ ┃ ┗ 📜chromedriver.exe
 ┃ ┣ 📂endpoints                       # API endpoints logic
 ┃ ┃ ┃ ┗ 📜screenshot.php
 ┃ ┗ 📂libs                            # Utility libraries
 ┃ ┃ ┣ 📜debug.php
 ┃ ┃ ┣ 📜img.php
 ┃ ┃ ┣ 📜request-handler.php
 ┃ ┃ ┣ 📜system.php
 ┃ ┃ ┗ 📜utils.php
 ┃ ┣ 📜api.php
 ┃ ┗ 📜screenshot.py
 ┣ 📜.gitignore
 ┣ 📜CHANGELOG.md
 ┣ 📜LICENSE.md
 ┣ 📜paths.php
 ┣ 📜README.md
 ┣ 📜require.php
 ┗ 📜todo
Clone this wiki locally