Skip to content

aalfiann/reSlim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

reSlim

Coverage reSlim License

reSlim is Lightweight, Fast, Secure, Simple, Scalable, Flexible and Powerful rest api framework.
reSlim is based on Slim Framework version 3.

Features:

  1. User management system
  2. File management system
  3. Pages management system
  4. Backup management system
  5. Package management system
  6. Token and API Key management system
  7. Auto log and trace error message
  8. Pagination json response
  9. Support Multi Language
  10. Server Side Caching to handle high traffic
  11. Scalable architecture with modular concept
  12. Easy horizontal scale because cache support multiserver
  13. Load Balancer with multiple database server (master to master or master to slave)
  14. Etc

Extensions:

  • Modules
    Here is the available modules created by reSlim author >> reSlim-modules.

  • UI Boilerplate
    Here is the basic UI template for production use with reSlim >> reSlim-ui-boilerplate.

System Requirements

  1. PHP 5.5 or newer (last tested on PHP7.3)
  2. MySQL 5.6 or MariaDB
  3. Web server with URL rewriting
  4. Apache or NGINX Server

Getting Started

I. Installation

  1. Get or download the project

  2. Extract then rename folder reSlim-master to reslim

  3. Open shell or CMD then go to src folder

    cd reslim/src
    
  4. Install it using Composer

    composer install
    
  5. Done

II. Connection Database

  1. Create Database name reSlim in your MySQL/MariaDB

  2. Execute or restore reSlim.sql which is located at resources/database/ folder

  3. Edit config.php which is located at src/ folder
    Just only this part,

    $config['db']['host']   = 'localhost';
    $config['db']['user']   = 'root';
    $config['db']['pass']   = 'root';
    $config['db']['dbname'] = 'reSlim';
    

    You can set the rest config later

  4. Done

III. Test

  1. Open your browser and visit >> http://localhost:1337/reslim/src/api/

Note: - My apache server is run on port 1337.

IV. Development

How to create new app or modules?
You can learn from documentation here >> Tutorial Create Module.
Or learn directly from this very simple project on Github.com.

V. Deployment

  1. Upload all files inside folder src to your server
  2. Backup local database and then restore to your server database online
  3. Done

Documentation

reSlim documentation is available on Wiki.

How to Contribute

Pull Requests

  1. Fork the reSlim repository
  2. Create a new branch for each feature or improvement
  3. Send a pull request from each feature branch to the develop branch