PHPackages                             guyliangilsing/php-base - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. guyliangilsing/php-base

ActiveProject[Utility & Helpers](/categories/utility)

guyliangilsing/php-base
=======================

A simple base project for custom PHP applications.

1.0.0(3y ago)03MITPHP

Since Sep 29Pushed 3y ago1 watchersCompare

[ Source](https://github.com/GuylianGilsing/PHPBase)[ Packagist](https://packagist.org/packages/guyliangilsing/php-base)[ RSS](/packages/guyliangilsing-php-base/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (8)Versions (3)Used By (0)

PHPBase
=======

[](#phpbase)

A simple base project for custom PHP applications.

Table of Contents
-----------------

[](#table-of-contents)

- [PHPBase](#phpbase)
    - [Table of Contents](#table-of-contents)
    - [Installation](#installation)
    - [Prerequisites](#prerequisites)
        - [Application and tool versions](#application-and-tool-versions)
        - [Required PHP extensions](#required-php-extensions)
        - [Running commands](#running-commands)
    - [Project setup](#project-setup)
        - [Install composer dependencies](#install-composer-dependencies)
        - [Create environment file](#create-environment-file)
    - [Webserver setup (optional)](#webserver-setup-optional)
        - [Application root directory](#application-root-directory)
        - [Request redirects](#request-redirects)
            - [Apache](#apache)
            - [Nginx](#nginx)
    - [Source directory structure](#source-directory-structure)
        - [App directory](#app-directory)
        - [Config directory](#config-directory)
        - [Framework directory](#framework-directory)
    - [Application startup process](#application-startup-process)
    - [Running the project locally](#running-the-project-locally)
    - [Running the project in docker](#running-the-project-in-docker)
        - [Build image](#build-image)
        - [Start container](#start-container)
        - [Stop container](#stop-container)
        - [Remove container](#remove-container)
    - [Static code analysis](#static-code-analysis)
        - [Running the tool](#running-the-tool)
        - [Receive a detailed report for your written source code](#receive-a-detailed-report-for-your-written-source-code)
        - [Configuring rules](#configuring-rules)
    - [Testing](#testing)
        - [Run unit test suite](#run-unit-test-suite)
        - [Run integration test suite](#run-integration-test-suite)

Installation
------------

[](#installation)

```
$ composer create-project guyliangilsing/php-base YOUR_PROJECT_NAME HERE
```

Prerequisites
-------------

[](#prerequisites)

Before this project base can be used, the following tools and applications must be installed and accessible through the command line:

- [Composer](https://getcomposer.org/)
- [PHP](https://www.php.net/downloads)
- [Docker](https://www.docker.com/)

### Application and tool versions

[](#application-and-tool-versions)

This project base has been created with the following application and tool versions:

NameMin. versionMax. versioncomposer2.4.2latestphp8.1.08.1.x### Required PHP extensions

[](#required-php-extensions)

The following extensions must be activated inside the `php.ini` file:

- curl
- fileinfo
- openssl

### Running commands

[](#running-commands)

Within this README file, there will be commands listed. All these commands must be run from the root directory. The root directory is the directory that this README file is located in.

**Note:** The version of composer does not matter, as long as it is version 2.

**IMPORTANT**: The listed versions have been used in the development of this project base and should work without any problems. Be mindful about other dependencies that you may add since they could not provide support for the given PHP version.

Project setup
-------------

[](#project-setup)

Before the project can be started, a setup process must be done first.

### Install composer dependencies

[](#install-composer-dependencies)

```
$ composer install
```

### Create environment file

[](#create-environment-file)

It is important that the contents of the `example.env` file is copied to a new `.env` file. The contents of the `.env` file are read at the start of each request to the application. Not creating this file will result in an exception error.

Webserver setup (optional)
--------------------------

[](#webserver-setup-optional)

When running this application on a webserver, make sure that the following setup process is done.

**Note**: For more information about a web server setup, visit the [slim framework documentation](https://www.slimframework.com/docs/v4/start/web-servers.html).

### Application root directory

[](#application-root-directory)

The root directory of the entire application is located within the `public` folder. When using an external webserver, make sure that the root directory inside your configuration is set to this folder.

### Request redirects

[](#request-redirects)

All requests should be redirected to the index.php file.

#### Apache

[](#apache)

Make sure that the following apache modules are actived:

- rewrite
- actions

```
# Redirects all incomming requests (and failed file paths) to the index.php file
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^ index.php [QSA,L]

```

#### Nginx

[](#nginx)

The following Nginx configuration can be used:

```
server {
    listen 80;
    server_name example.com;
    index index.php;
    error_log /path/to/example.error.log;
    access_log /path/to/example.access.log;
    root /path/to/public_folder;

    location / {
        try_files $uri /index.php$is_args$args;
    }

    location ~ \.php {
        try_files $uri =404;
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        include fastcgi_params;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        fastcgi_param SCRIPT_NAME $fastcgi_script_name;
        fastcgi_index index.php;
        fastcgi_pass 127.0.0.1:9123;
    }
}
```

Source directory structure
--------------------------

[](#source-directory-structure)

All code that directly provides functionality to the main application should be placed in the `src` (source) directory. Within `src`, the following folders are placed:

- `App` contains all application code.
- `Config` contains all application configuration code (dependency injection setup, ORM setup, loading .env files, etc.).
- `Framework` contains all code that provide basic functionality to the application startup process (providing a routing handler, registering dependency container definitions with the DI library, etc.)

### App directory

[](#app-directory)

The `App` directory contains all application code, a layered architecture is being used by default. The app directory has the following sub directories:

**Common**
This directory contains all code that needs to be re=used throughout each layer inside the application.

**Common\\Helpers**
This directory contains all helper code that needs to be re=used throughout each layer inside the application. It comes with a standard `HTTP` class that only provides a base for absolute paths.

**Presentation**
This directory contains all code for the presentation layer of the application. Within this directory, everything that provides functionality for the presentation side of your application should be placed here.

**Presentation\\Middleware**
This directory contains all middleware that the presentation layer needs to use. It comes with a standard middleware class that removes trailing, and duplicate, slashes from the URL.

### Config directory

[](#config-directory)

This directory contains all code that provides functionality for the startup process of the entire application. The directory comes with a singular `di.php` file that provides `DIConfig` classes. A `DIConfig` is a class that provides specific data to the dependency container.

**App**
This directory contains all configuration classes that provide functionality to the application.

**App\\Autoloading**
This directory contains `DIConfig` classes that provide specific data to the dependency container. A `DIConfig` class can be used to add [definitions](https://php-di.org/doc/definition.html) to the dependency container, or run a necesary startup process (like loading .env files or setting up a database connection). There are three default `DIConfig` classes:

- `SetupDependenciesDIConfig` adds generic dependency container definitions to the dependency container.
- `SetupEnvDIConfig` loads the `.env` file content and adds the variables to the `$_ENV` superglobal.
- `SetupRouterDIConfig` adds routing capability to the application (this is in a separate `DIConfig` class since this process should not be edited).

### Framework directory

[](#framework-directory)

This directory contains all code that provide basic functionality to the application startup process. The framework directory can also include general helpers and utilities, but this only should be done when this is necessary for the startup process, otherwise a `Common` directory of some sorts should be created inside the `./src/App` directory.

Application startup process
---------------------------

[](#application-startup-process)

It is very important to understand how this application base starts up and configures itself before a route can be registered. The application startup process goes as follows:

1. Create a dependency container.
2. Register all dependencies and run all startup processes.
3. Create a base application class that bootstraps a [Slim framework](https://www.slimframework.com/docs/v4/) `App` instance.
4. Register all middleware with the slim app instance.
5. Register routes.
6. Dispatch routes.

If, for whatever reason, the dependency container needs to be accessed for setting up something like an ORM, the `getDependencyContainer()` function runs step 1 and 2 of the startup process. This function can be called as soon as `./src/bootstrap.php` is included.

**IMPORTANT**: It is not possible to access the dependency container during steps 1 and 2. Do not call the `getDependencyContainer()` multiple times.

Running the project locally
---------------------------

[](#running-the-project-locally)

If the `php` command can be accessed from within a terminal or CLI, it can be used to run the project locally. For this the following two commands can be issued from the root directory:

```
$ cd public
$ php -S 127.0.0.1:8080
```

The first command changes the current directory to the `public` directory. This is the webserver root of the project and contains the entrypoint to the application.

The second command starts up a local php development server. A neat feature of this server is that it redirects everything back to an `index.php` file when there are no other available/matching files. If an actual webserver is needed, it is recommended to look at the docker section of this README file.

Running the project in docker
-----------------------------

[](#running-the-project-in-docker)

This project base comes with a preconfigured `Dockerfile` that is placed in the root directory. This file creates an image that uses apache as its webserver. The apache configuration file can be found in the `config` folder that is also placed in the root directory.

### Build image

[](#build-image)

Before you can run the docker container, you first need to build the image:

```
$ docker build ./ -t YOUR_IMAGE_NAME_HERE
```

### Start container

[](#start-container)

Once you an image, you can run it as follows:

```
$ docker run -it -p 127.0.0.1:8080:80 -td YOUR_IMAGE_NAME_HERE
```

**Note**: the command above starts this app on the following URL: [127.0.0.1:8080](http://127.0.0.1:8080)

### Stop container

[](#stop-container)

Once the container is running, you can stop it with the following command:

```
$ docker stop
```

**Note**: the container name can be found by running the following command:

```
$ docker ps
```

### Remove container

[](#remove-container)

Once the container is stopped, remove it with the following command:

```
$ docker rm
```

Static code analysis
--------------------

[](#static-code-analysis)

[PHP insights](https://phpinsights.com/) is used, and configured, to provide a static code analysis report of the application source code.

### Running the tool

[](#running-the-tool)

```
$ ./vendor/bin/phpinsights.bat
```

### Receive a detailed report for your written source code

[](#receive-a-detailed-report-for-your-written-source-code)

```
$ ./vendor/bin/phpinsights.bat analyse -v
```

### Configuring rules

[](#configuring-rules)

PHP insights's analysis rules can be configured through the `phpinsights.php` file inside the root directory.

Testing
-------

[](#testing)

[PHP unit](https://phpunit.de/) has been set up and configured with two testing suites: unit and integration. The configuration file (`phpunit.xml`) can be found in the root directory.

### Run unit test suite

[](#run-unit-test-suite)

```
$ ./vendor/bin/phpunit --configuration phpunit.xml --testsuite unit
```

### Run integration test suite

[](#run-integration-test-suite)

```
$ ./vendor/bin/phpunit --configuration phpunit.xml --testsuite integration
```

###  Health Score

21

—

LowBetter than 18% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1327d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/47211491?v=4)[Guylian Gilsing](/maintainers/GuylianGilsing)[@GuylianGilsing](https://github.com/GuylianGilsing)

---

Top Contributors

[![GuylianGilsing](https://avatars.githubusercontent.com/u/47211491?v=4)](https://github.com/GuylianGilsing "GuylianGilsing (2 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/guyliangilsing-php-base/health.svg)

```
[![Health](https://phpackages.com/badges/guyliangilsing-php-base/health.svg)](https://phpackages.com/packages/guyliangilsing-php-base)
```

###  Alternatives

[phlak/directory-lister

PHP directory lister

2.5k1.4k](/packages/phlak-directory-lister)[bacula-web/bacula-web

The open source web based reporting and monitoring tool for Bacula

1537.5k](/packages/bacula-web-bacula-web)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)