Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ScarletsFiction/Scarlets

A rewrited Scarlets framework for website based on PHP
https://github.com/ScarletsFiction/Scarlets

backend cli console fast framework php php-command scarletsfiction simple

Last synced: about 1 month ago
JSON representation

A rewrited Scarlets framework for website based on PHP

Host: GitHub
URL: https://github.com/ScarletsFiction/Scarlets
Owner: ScarletsFiction
License: mit
Created: 2018-08-01T22:24:45.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2020-12-25T14:13:10.000Z (almost 4 years ago)
Last Synced: 2024-08-02T20:46:03.409Z (4 months ago)
Topics: backend, cli, console, fast, framework, php, php-command, scarletsfiction, simple
Language: PHP
Homepage: https://scarlets-php.herokuapp.com
Size: 1.2 MB
Stars: 7
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-indo-projects - Scarlets - Multipurpose and high performance PHP framework. (Frameworks)
awesome-indonesia-repo - Scarlets - Multipurpose and high performance PHP framework. (Frameworks)

README

[![Software License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE)
[![Build Status](https://api.travis-ci.org/ScarletsFiction/Scarlets.svg?branch=master)](https://travis-ci.org/ScarletsFiction/Scarlets)
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](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
> 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

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
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

```sh
$ 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

```sh
$ 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
Scarlets have internal upgrade feature
```sh
$ 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

### 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
```sh
$ 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)

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)

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

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

## 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
Scarlets is under the MIT license.

Help improve this framework by support the author ＼(≧▽≦)／