jamesgober / php-project-structure-skeleton

A standard file and directory structure for PHP projects.

PHP PROJECT STRUCTURE SKELETON

 

<<<<<<< IN DEVELOPMENT >>>>>>

 

 

Directory Structure

Folder Names:	Folder MUST ONLY CONTAIN:
bin/	Command-Line files
config/	Configuration files
docs/	Documentation files
public/	Frontend scripts and assets.
resources/	Resource files
src/	PHP source code
tests/	Test code

For best-practice and standards compliance, a project's folder names MUST match the above example, and each folder MUST only contain the appropriate contents as defined above for each folder. The above folders are only required when a project contains the content associated with a folder.

 

Defa Structure

Files Names:	File Purpose:
CHANGELOG(.*)	Change log and version history.
CONTRIBUTING(.*)	Contributors guidelines.
LICENSE(.*)	Licensing information.
README(.*)	Project information overview

A package MUST use these names for these root-level files:

 

bin/              # Command-line files
config/           # configuration files
docs/             # documentation files
public/           # web files
resources/        # other resource files
src/              # PHP source files
tests/            # test files
CHANGELOG(.*)     # change notes
CONTRIBUTING(.*)  # contribution guidelines
LICENSE(.*)       # licensing information
README(.*)        # read-me-first file