2017 © Pedro Peláez
 

library apine-framework

APIne is a simple to use modular MVC Framework ready for use as a basic RESTful API.

image

youmy001/apine-framework

APIne is a simple to use modular MVC Framework ready for use as a basic RESTful API.

  • Sunday, April 29, 2018
  • by BinarMorker
  • Repository
  • 2 Watchers
  • 2 Stars
  • 208 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 20 Versions
  • 2 % Grown

The README.md

APIne Framework

This repository is no longer maintained here. The project is now hosted as apinephp/legacy-framework on GitLab., (*1)

APIne is a simple to use modular MVC Framework ready for use as a RESTful API. It intends to be a general purpose framework and a RESTful service providing basic session management, authentication, routing, and database abstraction without including useless tools. APIne's focus is to let you work without imposing to relearn PHP., (*2)

You may per se, use APIne for solely for its routing system and its MVC approach then use your favorite PHP libraries for everything else., (*3)

APIne already implements a comprehensive session manager, a basic yet effective Entity manager, and, TWIG as its template manager — enough to boot any kind of project., (*4)

Requirements

For APIne 2: * PHP 7.2 or greater with the PDO extension * MySQL 5.6 or MariaDB 10.1 or greater * Apache 2.4 with mod_rewrite, (*5)

For APIne 1.1: * PHP 5.6 or greater with PDO extension * MySQL 5.6 or MariaDB 10.1 or greater * Apache 2.4 with mod_rewrite, (*6)

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., (*7)

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., (*8)

Installation

APIne Framework is available as a Composer Package on Packagist as well as a standalone project., (*9)

APIne 2.0 is currently under heavy development thus is not ready for use. It is recommended to install the stable version of the framework instead., (*10)

With Composer

Add the following line to your composer.json file : "youmy001/apine-framework": ^1.1". Or enter this command : $ composer require youmy001/apine-framework., (*11)

Standalone

Clone this repository in your working directory : $ git clone https://github.com/Youmy001/apine_framework.git. Then checkout to the branch of the latest stable release: git checkout 1.1.x., (*12)

Quick 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., (*13)

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., (*14)

If you run a standalone version of APIne's, install depedancies using this command after going through the assistant : $ php composer.phar install., (*15)

Manually Start a Project

First of all, in order to use APIne Framework, you must copy this file to the root of your project :, (*16)

  • apine-framework/Installation/htacess_template.php

Then replace the PHP tag by the path to APIne. If you are using APIne as a Composer package, this will be /vendor/youmy001/apine-framework. If you are using a standalone APIne, this will likely be /apine-framework. And rename the file .htaccess., (*17)

Next, create a index.php file and add the following content in it:, (*18)

require_once 'vendor/autoload.php'; // If APIne is a Composer package
//require_once 'apine-framework/Autoloader.php'; // If APIne is standalone

$loader = new Apine\Autoloader();
$loader->register();

$apine = new Apine\Application\Application();
$apine->set_mode(APINE_MODE_DEVELOPMENT);
$apine->run(APINE_RUNTIME_HYBRID);

Finally, you will need to create a file name config.ini that will contain various configuration information. Complete the following in your config file :, (*19)

[application]
title = "Project Name"
author = "Author Name"
description = "Description"
[database]
host = "localhost"
type = "mysql"
dbname = "projectdb"
charset = "utf8"
username = "root"
password = ""
[localization]
timezone_default = "America/New_York"
locale_default = "en_US"
locale_detection = "yes"
locale_cookie = "no"
[runtime]
token_lifespan = "600"
default_layout = "default"

Learn More

Learn More at the following links :, (*20)

Support

Get support at the following links :, (*21)

License

The APIne Framework is distributed under the MIT license. See the LICENSE file for more information., (*22)

The Versions

29/04 2018

dev-master

9999999-dev

APIne is a simple to use modular MVC Framework ready for use as a basic RESTful API.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Tommy Teasdale

18/04 2018

1.2.x-dev

1.2.9999999.9999999-dev

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

21/01 2018

dev-no_database

dev-no_database

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

18/05 2017

1.1.x-dev

1.1.9999999.9999999-dev

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

18/05 2017

1.1.3

1.1.3.0

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

19/02 2017

1.1.2

1.1.2.0

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

12/01 2017

1.1.0

1.1.0.0

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

12/01 2017

1.1.1

1.1.1.0

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

05/11 2016

dev-BinarMorker-APISession-FIX

dev-BinarMorker-APISession-FIX

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

05/11 2016

dev-Basic-HTTP-Authentication-FIX

dev-Basic-HTTP-Authentication-FIX

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

07/10 2016

2.0.x-dev

2.0.9999999.9999999-dev

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

07/10 2016

1.0.x-dev

1.0.9999999.9999999-dev

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

07/10 2016

1.0.4

1.0.4.0

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

04/10 2016

1.0.3

1.0.3.0

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

10/09 2016

1.0.2

1.0.2.0

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

06/09 2016

1.0.1

1.0.1.0

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

03/05 2016

1.0.0

1.0.0.0

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things).

  Sources   Download

MIT

The Requires

 

by Tommy Teasdale

08/04 2016

1.0.0.rc.3.1

1.0.0.0-RC3.1

  Sources   Download

The Requires

 

14/03 2016

v1.0.0.rc.3

1.0.0.0-RC3

  Sources   Download

The Requires

 

25/11 2015

v1.0.0.rc.2

1.0.0.0-RC2

  Sources   Download

The Requires