Installation

The installation of this project can be done with Composer:

composer create-project aplus/app

Or, to install the latest LTS version:

composer create-project aplus/app:^24

Structure

The App has a standard structure to organize business logic.

And remember, it's highly customizable. You can adapt it as you like.

This is the basic directory tree:

.
├── app/
│   ├── Commands/
│   │   └── Index.php
│   ├── Controllers/
│   │   └── Home.php
│   ├── Languages/
│   ├── Models/
│   └── Views/
├── App.php
├── bin/
│   └── console
├── boot/
│   ├── app.php
│   ├── constants.php
│   ├── helpers.php
│   ├── init.php
│   ├── routes.php
│   └── set-env.php
├── composer.json
├── config/
├── .env.php
├── preload.php
├── public/
│   └── index.php
├── storage/
├── tests/
└── vendor/

Bootstrap

Inside the boot directory are located files that are part of the application startup.

The app.php file returns the instance of the App class, which is called to run the application in HTTP or CLI.

Configuration

Aplus App is organized in such a way that its configuration files are all in the same directory.

By default, the directory is called config. Located in the application's root directory.

Configuration files serve to pre-establish values used by services or routines needed for helpers and libraries.

For more details see the Config and MVC libraries documentation.

Storage

In the storage directory, different types of files are stored in subdirectories:

The global class App

The global class App, whose file is located in the root directory, extends the Framework\MVC\App class.

Through it, it is possible to customize features and services.

The App namespace

Inside the app directory is registered the App namespace.

By default, some files are already inside it:

Running an Aplus App

The Aplus App project is designed to run on HTTP and CLI.

Testing

Unit tests can be created within the tests directory. See the tests that come inside it as an example.

Deployment

We will see how to deploy to a Shared Hosting and a Private Server:

In the following examples, configurations will be made for the domain domain.tld. Replace it with the domain of your application.

$_ENV['ENVIRONMENT'] = 'production';

$_ENV['app.default.origin'] = 'http://domain.tld';

composer install --no-dev

Private Server

We will be using Ubuntu 24.04 LTS which is supported until 2029 and already comes with PHP 8.3.

Replace domain.tld with your domain.

Installing PHP and required packages:

sudo apt-get -y install \
composer \
curl \
git \
php8.3-cli \
php8.3-curl \
php8.3-fpm \
php8.3-gd \
php8.3-igbinary \
php8.3-intl \
php8.3-mbstring \
php8.3-memcached \
php8.3-msgpack \
php8.3-mysql \
php8.3-opcache \
php8.3-readline \
php8.3-redis \
php8.3-xdebug \
php8.3-xml \
php8.3-yaml \
php8.3-zip \
unzip

Make the application directory:

sudo mkdir -p /var/www/domain.tld

Set directory ownership. Replace "username" with your username:

sudo chown username:username /var/www/domain.tld

Enter the application directory...

cd /var/www/domain.tld

... and clone or download your project.

As an example, we'll install a new app:

git clone https://github.com/aplus-framework/app.git .

Set storage directory permissions:

chmod -R 777 storage/*

Edit the Environment and the URL Origin of your project in the .env.php file:

$_ENV['ENVIRONMENT'] = 'production';
$_ENV['app.default.origin'] = 'http://domain.tld';

Install the necessary PHP packages through Composer:

composer install --no-dev

sudo apt install apache2 libapache2-mod-php

sudo a2enmod rewrite

<Directory /var/www/domain.tld/public>
    Options Indexes FollowSymLinks
    AllowOverride All
    Require all granted
</Directory>
<VirtualHost *:80>
    ServerName domain.tld
    SetEnv ENVIRONMENT production
    DocumentRoot /var/www/domain.tld/public
</VirtualHost>

sudo a2ensite domain.tld

sudo systemctl reload apache2

sudo sed -i 's/;cgi.fix_pathinfo=1/cgi.fix_pathinfo=0/g' /etc/php/8.1/fpm/php.ini

sudo systemctl restart php8.3-fpm

sudo apt install nginx

server {
    listen 80;

    root /var/www/domain.tld/public;

    index index.php;

    server_name domain.tld;

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

    location ~ \.php$ {
        include snippets/fastcgi-php.conf;
        fastcgi_param ENVIRONMENT production;
        fastcgi_pass unix:/var/run/php/php8.3-fpm.sock;
    }

    location ~ /\. {
        deny all;
    }
}

sudo ln -s /etc/nginx/sites-available/domain.tld.conf /etc/nginx/sites-enabled/

sudo nginx -t

sudo systemctl restart nginx