Get Started - WaZeR-Adrien/Lightwork-api GitHub Wiki

Lightwork API [v4.0.0]

Lightwork API is a light PHP framework object oriented with many features in MVC.

Installation :

  • Clone the repository
  • Rename kernel/Config-sample.php by kernel/Config.php
  • Edit config by your own information
  • Execute : composer install
  • Optional (to use token system) : create a table Auth with 4 fields (pk int id, fk int user_id, string token, string date) to use the secure system route by token

More info :

  • Many examples are available in files of the framework like the routes (in index.php and documentation)
  • The documentation of your API is auto generate
  • For the documentation generation to be perfect, fill in the information on each of the routes in the index.php

Structure of files :

  • App : Your MVC Files : Controllers / Models / Views (for doc)
  • Kernel : The kernel of the website : Config / Router / Http / Database / Logs...
  • Public : Your public files : JS / CSS...
  • Main index.php : The main file of the site with the autoload, routing...

Summary :