Home

Welcome to Scarlets Framework!

You can choose the documentation on the right menu.

Notes

This framework mainly focus on performance and currently being developed and may have some breaking changes on complex usage. With this framework you can freely build your project with Object Oriented Programming or Procedural Programming style. For best performance it's good for using Procedural Programming style, but you must write your code on a scope like using Namespace or Static Class.

Simplicity

If you write your code in /app folder, you could easily refer it scope with /App/Subfolder/YourFileNamespace without using require or include anymore. There also an example on this repository if you still unsure.

If you installed this framework without composer and just installed library with composer, make sure you uncomment

// require "../vendor/autoload.php";

// into
require "vendor/autoload.php";

in /root.php

Feature

This framework also have build-in server so you don't need to use Nginx or Apache for development purpose. In production mode I highly recommend to use Nginx because the PHP thread will be cleared after use by a user and can avoid conflict. Enabling Opcache also recommended to reduce PHP file parsing.

Instead of that, there are some extended feature that this framework offer.

• Easy and customizable command line interface
• Many set of functions that can being called easily
• Build-in Web API, AccessToken and Authorization
• Additional security to avoid path climbing, SQL Injection
• Auto load required script and easy use of namespace from the /app folder
• Designed to be combined with the Scarlets's frontend framework
  • As a template/language server (sf.lang)
  • Dynamic Routing (sf.views)
  • Easy API call (sf.API)
• And much more

Contribute

There may have some bugs too, and please post an issue or pull request if you found it ^.^)/
Good luck with your project!