Skip to content

Home

Jump to bottom
Tommy Teasdale edited this page Dec 6, 2015 · 28 revisions

APIne Framework Wiki

APIne is a simple to use modular MVC Framework ready for the IoT (Internet of Things). It intends to be a general purpose framework and API providing session management, authentication, routing, and a database abstraction without including useless tools.

The most notable features include a complete session manager (login, logout, registration and password restoration) with basic users and permissions and a database abstraction layer that prevents you to write every queries.

Requirements

  • PHP 5.4.0 or greater
  • MySQL 5
  • Apache 2.4
  • mod_rewrite
  • filter_module

The project must be set in a virtual host that allows rewrites for the routes to work.

Installation

  1. Clone this project in your working directory

    $git clone https://github.com/Youmy001/apine_framework.git

  2. Setup a virtual host for the project directory that allow rewrite rules and optionaly has mod_deflate and filter_module enabled in apache for version 2.4 or greater.

  3. Import resources/apine_sql_tables.sql into your database. This file includes the instructions to create the tables needed by the framework.

  4. Create a copy of sample_config.ini named config.ini.

  5. Edit the Database section in config.ini to include connection to your database. Check the wiki for more informations on configuration.

  6. Install composer depandancies with the following command :

    $ php composer.phar install

  7. Open your browser and go to your virtual host address. APIne Framework is now ready to work.

Framework Documentation

Clone this wiki locally