PHPackages                             youmy001/apine-framework - 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. [Framework](/categories/framework)
4. /
5. youmy001/apine-framework

Abandoned → [apinephp/legacy-framework](/?search=apinephp%2Flegacy-framework)Library[Framework](/categories/framework)

youmy001/apine-framework
========================

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

1.1.3(9y ago)22281MITPHPPHP >=5.6.0

Since Nov 25Pushed 7y ago2 watchersCompare

[ Source](https://github.com/Youmy001/apine-framework)[ Packagist](https://packagist.org/packages/youmy001/apine-framework)[ RSS](/packages/youmy001-apine-framework/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (4)Versions (16)Used By (0)

APIne Framework
===============

[](#apine-framework)

> This repository is no longer maintained here. The project is now hosted as [apinephp/legacy-framework](https://gitlab.com/apinephp/legacy-framework) on GitLab.

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.

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.

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.

Requirements
------------

[](#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

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

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
------------

[](#installation)

APIne Framework is available as a Composer Package on Packagist as well as a standalone project.

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.

### With Composer

[](#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`.

### Standalone

[](#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`.

Quick Start a Project
---------------------

[](#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.

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 depedancies using this command after going through the assistant : `$ php composer.phar install`.

Manually Start a Project
------------------------

[](#manually-start-a-project)

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

- 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`.

Next, create a `index.php` file and add the following content in it:

```
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 :

```
[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)

Learn More at the following links :

- [Documentation](https://github.com/Youmy001/apine-framework/wiki)
- [Example Project](https://github.com/Youmy001/apine-framework-example)

Support
-------

[](#support)

Get support at the following links :

- [Email Assistance](mailto:tteasdaleroads@gmail.com?subject=Support%20Request%20APIne%20Framework)
- [Issue Tracker](https://github.com/Youmy001/apine-framework/issues)
- [Public Wiki](https://github.com/Youmy001/apine-framework/wiki)

License
-------

[](#license)

The APIne Framework is distributed under the MIT license. See the [LICENSE file](https://github.com/Youmy001/apine-framework/blob/master/LICENSE) for more information.

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 96.2% 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

Every ~62 days

Recently: every ~115 days

Total

15

Last Release

2995d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/3418553?v=4)[Tommy Teasdale](/maintainers/Youmy001)[@Youmy001](https://github.com/Youmy001)

![](https://www.gravatar.com/avatar/3a9a232a9f6c940d16149a164764e88063e54c299497389c96e449e7ef5bc061?d=identicon)[BinarMorker](/maintainers/BinarMorker)

---

Top Contributors

[![Youmy001](https://avatars.githubusercontent.com/u/3418553?v=4)](https://github.com/Youmy001 "Youmy001 (307 commits)")[![BinarMorker](https://avatars.githubusercontent.com/u/5797290?v=4)](https://github.com/BinarMorker "BinarMorker (12 commits)")

---

Tags

frameworkmvcmvc-frameworkmysqlphp

### Embed Badge

![Health badge](/badges/youmy001-apine-framework/health.svg)

```
[![Health](https://phpackages.com/badges/youmy001-apine-framework/health.svg)](https://phpackages.com/packages/youmy001-apine-framework)
```

###  Alternatives

[matomo/matomo

Matomo is the leading Free/Libre open analytics platform

21.6k38.2k](/packages/matomo-matomo)[chameleon-system/chameleon-base

The Chameleon System core.

1027.9k4](/packages/chameleon-system-chameleon-base)[sproutcms/cms

Enterprise content management and framework

242.2k4](/packages/sproutcms-cms)

PHPackages © 2026

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