sunlight-cms/skeleton

SunLight CMS project template

v1.1.1 2024-04-06 12:17 UTC

Requires

• php: >=7.1
• ext-ctype: *
• ext-gd: *
• ext-hash: *
• ext-json: *
• ext-mbstring: *
• ext-mysqli: *
• ext-session: *
• ext-zip: *
• composer/semver: ^3.4.0
• ezyang/htmlpurifier: ^4.17
• kuria/cache: ^6.0
• kuria/debug: ^4.0.1
• kuria/error: ^4.2.3
• kuria/event: ^2.0.1
• kuria/options: ^2.1
• kuria/request-info: ^1.0.2
• kuria/url: ^5.0
• sunlight-cms/console: ^1.1
• xemlock/htmlpurifier-html5: ^0.1.11

MIT

README

This is a SunLight CMS template project.

Contents

• Creating a new project
• SunLight console
• Default .gitignore
• Updating SunLight CMS
  • Applying patches
  • Redownloading CMS files

Creating a new project

You can create a new project using the Composer's create-project command:

composer create-project sunlight-cms/skeleton my-website

This will create a "my-website" directory with all of the required files inside.

SunLight console

This project contains preconfigured sunlight-cms/console which is used to maintain the CMS files.

• CMS files are downloaded automatically after you run composer install or composer update
• the console reads configuration from your project's composer.json
• see sunlight-cms/console documentation for a list of all available commands and options

Default .gitignore

There is a default .gitignore file that ignores most of the CMS files.

The idea is to commit only your templates and/or plugins and rely on the console to maintain the CMS files.

Updating SunLight CMS

When a new project is created, the latest 8.x version of SunLight CMS is downloaded. That version is then set into cms.version.

Applying patches

If you wish to upgrade to a newer version, you can apply patches using the bin/console cms.patch command. This will also update cms.version in composer.json.

Redownloading CMS files

If you just want to overwrite the CMS files with a different version, you can edit cms.version manually and then run bin/console cms.download --overwrite. Note that doing this will not patch your database or perform any other updates.