README

Scriptor

Scriptor is a lightweight and versatile flat-file CMS for creating microsites, blogs, or wikis.

Get started quickly:

The intuitive control panel helps you get up and running quickly - you'll have it installed in no time. A basic blog theme is already pre-installed, so you can get started right away. Use the default theme or create your own theme with ease.

Installation

Requirements

To install Scriptor, make sure you have the following:

A Unix or Windows-based web server running Apache.
Minimum PHP version 8.1.
ext-mbstring
ext-gd
ext-dom
ext-json
Apache must support the .htaccess file.

Via Composer Create-Project

You can install Scriptor by using Composer. Run the following command:

composer create-project bigins/scriptor your-scriptor-project

Via Composer Require

If you prefer, you can add Scriptor to an existing project inside the vendor/ directory:

composer require bigins/scriptor

Git Clone

git clone git@github.com:bigin/Scriptor.git

Installing from a Zip Archive

To install Scriptor from a zip archive, follow these steps:

Click Download to download the archive.
Unpack the archive.
Upload the contents of the Scriptor folder to the root directory on the server. Alternatively, you can upload it to a folder if you want to run the CMS in a subfolder. If you only want to interact programmatically with Scriptor, place the library outside the root directory. For more information, see the section on "Using Scriptor as a library" below.

Use Scriptor as your website platform

If you want to use Scriptor as your website platform, it should be located in the root directory of your domain.

Admin panel

To access the admin panel, go to the home page of your website and simply add the text editor/ to the URL in your browser:

https://your-website.com/editor/

If you are using Scriptor in a subdirectory:

https://your-website.com/subdirectory/editor/

Admin initial login

(!) Change password/username at first login

User: admin
Password: gT5nLazzyBob

Use Scriptor as a library

To include the Scriptor library in your own project, simply add the boot.php file:

require './your-scriptor-project/boot.php';

or use composer autoload:

require '../vendor/autoload.php';

Now you can use Scriptor in your own code:

<?php // /public/index.php

use Scriptor\Core\Scriptor;

require dirname(__DIR__) . '/vendor/autoload.php';

$page = Scriptor::getSite()->pages()->getPage('slug=scriptors-demo-page');

Header image by

Freepik

License

The MIT License (MIT)

bigins / scriptor

Maintainers

Details