PHPackages                             scarletsfiction/scarlets - 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. scarletsfiction/scarlets

ActiveLibrary[Framework](/categories/framework)

scarletsfiction/scarlets
========================

Scarlets is a web framework that can help you build a website with API and another build-in system.

0.8.0(6y ago)7141MITPHPPHP >=5.6

Since Aug 12Pushed 5y ago2 watchersCompare

[ Source](https://github.com/ScarletsFiction/Scarlets)[ Packagist](https://packagist.org/packages/scarletsfiction/scarlets)[ RSS](/packages/scarletsfiction-scarlets/feed)WikiDiscussions master Synced yesterday

READMEChangelog (3)DependenciesVersions (4)Used By (0)

[![](https://camo.githubusercontent.com/b9229446d8e2c15a6ed49de499f96f85e76274ba1ea889cf55647675ce08370c/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e742e7376673f75726c3d6874747073253341253246253246736869656c6473696f2d70617472656f6e2e6865726f6b756170702e636f6d25324673746566616e7361727961253246706c6564676573267374796c653d666f722d7468652d6261646765)](https://patreon.com/stefansarya)

[![Software License](https://camo.githubusercontent.com/1a2e0606685ce00663bf829868f794fd3fc9c86f8d80cae324734129e0723a58/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d627269676874677265656e2e737667)](LICENSE)[![Build Status](https://camo.githubusercontent.com/409246f4363fca67fe289c3db69c882b327a4e5cce221b3b8b94e23a86638f2c/68747470733a2f2f6170692e7472617669732d63692e6f72672f536361726c65747346696374696f6e2f536361726c6574732e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/ScarletsFiction/Scarlets)[![Tweet](https://camo.githubusercontent.com/cb820a0ecc9645168e33b03925d7f14691262ddbaeaf66a0a91697803d0cba2d/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f75726c2f687474702f736869656c64732e696f2e7376673f7374796c653d736f6369616c)](https://twitter.com/intent/tweet?text=Scarlets%20is%20a%20web%20framework%20for%20PHP%20that%20can%20help%20you%20build%20a%20website%20with%20API%20and%20another%20build-in%20system.%20This%20framework%20does%20a%20lazyload%20of%20it's%20system%20to%20keep%20your%20website%20in%20a%20high%20performance%20state&url=https://github.com/ScarletsFiction/Scarlets&via=github&hashtags=scarlets,framework,php)

Scarlets
========

[](#scarlets)

> This framework still under development

Scarlets is a web framework for PHP that can help you build a website with API and another build-in system. This framework have a lazyload on it's system, so you can select which system that you want to use to keep your website in a high performance state.

Installation instruction
------------------------

[](#installation-instruction)

Clone/download this repository and put it on a folder.
Then copy the example folder and edit the framework path on `root.php`

### Install by using command prompt

[](#install-by-using-command-prompt)

Make sure you have installed PHP on your computer (Windows and OSX can use [XAMPP](https://www.apachefriends.org/index.html))
and make sure the php command is available on the command prompt

```
$ php -v
```

If not, then you need to set it up on the [environment variables](https://www.youtube.com/watch?v=51IlfNzZVGo).

When the php command is available, open your command prompt and enter this line

```
$ php -r "copy('https://raw.githubusercontent.com/ScarletsFiction/Scarlets/master/net-install', 'net-install');"
$ php net-install
```

The framework will automatically installed, and the example files will be prepared on your project folder.

Upgrade
-------

[](#upgrade)

Scarlets have internal upgrade feature

```
$ php scarlets upgrade
```

But if there are any error and the framework was unable to be loaded
Please clone this repository and extract it to `/vendor/scarletsfiction/scarlets`

Getting Started
---------------

[](#getting-started)

### Setup your custom website domain

[](#setup-your-custom-website-domain)

Before we started, we need to setup Apache or Nginx to route every HTTP request into `/public/` directory.

- On Apache, you could setup [VirtualHost](https://gist.github.com/hoandang/8066175).
- On Nginx, you will need to add [new site configuration](http://blog.manugarri.com/how-to-easily-set-up-subdomain-routing-in-nginx/).

If you're using Windows, you can use [Laragon](https://laragon.org/) to easily `Switch Document Root` that will automatically create new Apache VirtualHost and modify `drivers\etc\hosts` for you. So you can easily access your project with a custom domain.

This framework has a build-in server by calling

```
$ php scarlets serve (port) (address) (options)
```

> Address: localhost, network, IPAddress
> Options: --log, --verbose

[![serve_command](https://user-images.githubusercontent.com/11073373/62832370-f5e2c680-bc56-11e9-9693-932e2b910f21.png)](https://user-images.githubusercontent.com/11073373/62832370-f5e2c680-bc56-11e9-9693-932e2b910f21.png)

Even the build-in server was blazingly fast, it still have some problem because it's running in a single thread for every request. So it's very recommended to setup your website using Nginx. But if you want to deploy a small server into Raspberry PI, Android, or other linux devices it may be better to use the build-in server.

You can also create your own command for your project

[![interactive_console](https://user-images.githubusercontent.com/11073373/62832369-f54a3000-bc56-11e9-829e-0c7cca9b8a40.png)](https://user-images.githubusercontent.com/11073373/62832369-f54a3000-bc56-11e9-829e-0c7cca9b8a40.png)

The user defined command are editable on `/routes/console.php`

### Documentation

[](#documentation)

The usage on how to use this framework is in the [Wiki](https://github.com/ScarletsFiction/Scarlets/wiki)

Contribution
------------

[](#contribution)

If you want to help in Scarlets framework, please fork this project and edit on your repository, then make a pull request to here.

License
-------

[](#license)

Scarlets is under the MIT license.
Help improve this framework by support the author ＼(≧▽≦)／

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~224 days

Total

3

Last Release

2382d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b1f8514602bd980243d202d81263e620513484e274b7938725952039360d1b6c?d=identicon)[StefansArya](/maintainers/StefansArya)

---

Top Contributors

[![StefansArya](https://avatars.githubusercontent.com/u/11073373?v=4)](https://github.com/StefansArya "StefansArya (405 commits)")

---

Tags

backendcliconsolefastframeworkphpphp-commandscarletsfictionsimplephpframeworkwebsitescarlets

### Embed Badge

![Health badge](/badges/scarletsfiction-scarlets/health.svg)

```
[![Health](https://phpackages.com/badges/scarletsfiction-scarlets/health.svg)](https://phpackages.com/packages/scarletsfiction-scarlets)
```

###  Alternatives

[fuel/fuel

FuelPHP is a simple, flexible, community driven PHP 5.4+ framework, based on the best ideas of other frameworks, with a fresh start!

1.5k42.3k](/packages/fuel-fuel)[luyadev/luya

LUYA is a scalable web framework and content management system with the goal to please developers, clients and users alike.

8086.9k2](/packages/luyadev-luya)

PHPackages © 2026

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