{"id":27251511,"url":"https://github.com/scarletsfiction/scarlets","last_synced_at":"2025-04-11T01:10:10.519Z","repository":{"id":62541039,"uuid":"143214434","full_name":"ScarletsFiction/Scarlets","owner":"ScarletsFiction","description":"A rewrited Scarlets framework for website based on PHP","archived":false,"fork":false,"pushed_at":"2020-12-25T14:13:10.000Z","size":1261,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-11T01:10:04.064Z","etag":null,"topics":["backend","cli","console","fast","framework","php","php-command","scarletsfiction","simple"],"latest_commit_sha":null,"homepage":"https://scarlets-php.herokuapp.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ScarletsFiction.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":"stefansarya","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":"stefansarya","issuehunt":"stefansarya","otechie":null,"custom":["https://paypal.me/stefansarya"]}},"created_at":"2018-08-01T22:24:45.000Z","updated_at":"2024-07-16T11:00:30.000Z","dependencies_parsed_at":"2022-11-02T15:45:32.099Z","dependency_job_id":null,"html_url":"https://github.com/ScarletsFiction/Scarlets","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScarletsFiction%2FScarlets","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScarletsFiction%2FScarlets/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScarletsFiction%2FScarlets/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScarletsFiction%2FScarlets/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ScarletsFiction","download_url":"https://codeload.github.com/ScarletsFiction/Scarlets/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248322601,"owners_count":21084337,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","cli","console","fast","framework","php","php-command","scarletsfiction","simple"],"created_at":"2025-04-11T01:10:09.922Z","updated_at":"2025-04-11T01:10:10.514Z","avatar_url":"https://github.com/ScarletsFiction.png","language":"PHP","funding_links":["https://patreon.com/stefansarya","https://liberapay.com/stefansarya","https://issuehunt.io/r/stefansarya","https://paypal.me/stefansarya","https://patreon.com/stefansarya'"],"categories":[],"sub_categories":[],"readme":"\u003ca href='https://patreon.com/stefansarya'\u003e\u003cimg src='https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fstefansarya%2Fpledges\u0026style=for-the-badge' height='20'\u003e\u003c/a\u003e\n\n[![Software License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE)\n[![Build Status](https://api.travis-ci.org/ScarletsFiction/Scarlets.svg?branch=master)](https://travis-ci.org/ScarletsFiction/Scarlets)\n[![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\u0026url=https://github.com/ScarletsFiction/Scarlets\u0026via=github\u0026hashtags=scarlets,framework,php)\n\n# Scarlets\n\u003e This framework still under development\n\nScarlets 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.\n\n## Installation instruction\n\nClone/download this repository and put it on a folder.\u003cbr\u003e\nThen copy the example folder and edit the framework path on `root.php`\n\n### Install by using command prompt\nMake sure you have installed PHP on your computer (Windows and OSX can use [XAMPP](https://www.apachefriends.org/index.html))\u003cbr\u003e\nand make sure the php command is available on the command prompt\n\n```sh\n$ php -v\n```\n\nIf not, then you need to set it up on the [environment variables](https://www.youtube.com/watch?v=51IlfNzZVGo).\n\nWhen the php command is available, open your command prompt and enter this line\n\n```sh\n$ php -r \"copy('https://raw.githubusercontent.com/ScarletsFiction/Scarlets/master/net-install', 'net-install');\"\n$ php net-install\n```\n\nThe framework will automatically installed, and the example files will be prepared on your project folder.\n\n## Upgrade\nScarlets have internal upgrade feature\n```sh\n$ php scarlets upgrade\n```\n\nBut if there are any error and the framework was unable to be loaded\u003cbr\u003e\nPlease clone this repository and extract it to `/vendor/scarletsfiction/scarlets`\n\n## Getting Started\n\n### Setup your custom website domain\nBefore we started, we need to setup Apache or Nginx to route every HTTP request into `/public/` directory.\n - On Apache, you could setup [VirtualHost](https://gist.github.com/hoandang/8066175).\n - On Nginx, you will need to add [new site configuration](http://blog.manugarri.com/how-to-easily-set-up-subdomain-routing-in-nginx/).\n\nIf 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.\n\nThis framework has a build-in server by calling\n```sh\n$ php scarlets serve (port) (address) (options)\n```\n\n\u003e Address: localhost, network, IPAddress\u003cbr\u003e\n\u003e Options: --log, --verbose\u003cbr\u003e\n\n![serve_command](https://user-images.githubusercontent.com/11073373/62832370-f5e2c680-bc56-11e9-9693-932e2b910f21.png)\n\nEven 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.\n\nYou can also create your own command for your project\n\n![interactive_console](https://user-images.githubusercontent.com/11073373/62832369-f54a3000-bc56-11e9-829e-0c7cca9b8a40.png)\n\nThe user defined command are editable on `/routes/console.php`\u003cbr\u003e\n\n### Documentation\nThe usage on how to use this framework is in the [Wiki](https://github.com/ScarletsFiction/Scarlets/wiki)\n\n## Contribution\nIf you want to help in Scarlets framework, please fork this project and edit on your repository, then make a pull request to here.\n\n## License\nScarlets is under the MIT license.\u003cbr\u003e\nHelp improve this framework by support the author ＼(≧▽≦)／","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscarletsfiction%2Fscarlets","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscarletsfiction%2Fscarlets","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscarletsfiction%2Fscarlets/lists"}