Requirements

The following are the minimum server requirements for APIne :

• PHP 5.6 or greater with PDO extension;
• MySQL 5.6 or MariaDB 10.1 or greater;
• Apache 2.4 with mod_rewrite active;

The project using APIne must be installed at the root of a host that must include the instruction AllowOverride FileInfo Options Indexes for the default settings. PHP's user must also have writing permissions on the project directory.

APIne does not officially support any other HTTP server (nginx, lighttpd, ...). If you are using one of those you might need modify your server's configuration.

Installation

Installing APIne is rather easy. The best way to install is through its Composer package. APIne Framework is available as a Composer Package on Packagist as well as a standalone library.

Using Composer

Add the following line to your composer.json file :

“youmy001/apine-framework”: “~1.1”

Or use the following command :

composer require youmy001/apine-framework

As a Stand-alone Library

Clone APIne's repository in your working directory using the following command:

git clone https://github.com/youmy001/apine-framework.git

Then checkout to the latest stable release:

git checkout tags/1.1.3

Start a Project

To quickly start a new project execute the assistant in a web browser located at http://[domain_name_of_your_project]/apine-framework/install.php if APIne is used standalone or http://[domain_name_of_your_project]/vendor/youmy001/apine-framework/install.php if it is used as a composer package, and follow the steps. The assistant will automatically generate a basic config, an empty locale, a .htaccess file, and a basic index.php and will automatically download the latest version of Composer's binary if you are using the standalone version.

The assistant will also try to import some tables essential for APIne's operation. Make sure you already created a database before launching the assistant and that the database is accessible from your project's perspective.

If you run a standalone version of APIne's, install dependencies using this command after going through the assistant :

$ php composer.phar install.