getformwork / formwork
A file-based Content Management System (CMS) to make and manage simple sites
Installs: 214
Dependents: 0
Suggesters: 0
Security: 3
Stars: 53
Watchers: 4
Forks: 12
Open Issues: 2
Type:project
Requires
- php: >=8.2
- ext-dom: *
- ext-fileinfo: *
- ext-gd: *
- ext-mbstring: *
- ext-openssl: *
- ext-zip: *
- jaybizzle/crawler-detect: ^1.2
- league/commonmark: ^2.4
- masterminds/html5: ^2.9
- symfony/polyfill-ctype: ^1.23
- symfony/yaml: ^7.0.3
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- league/climate: ^3.8
- phpstan/phpstan: ^1.10
- rector/rector: ^1.0.4
- symfony/process: ^7.0.4
- 2.x-dev
- 2.0.0-beta.2
- 2.0.0-beta.1
- 1.x-dev
- 1.13.1
- 1.13.0
- 1.12.1
- 1.12.0
- 1.11.1
- 1.11.0
- 1.10.3
- 1.10.2
- 1.10.1
- 1.10.0
- 1.9.1
- 1.9.0
- 1.8.0
- 1.7.1
- 1.7.0
- 1.6.1
- 1.6.0
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.7
- 1.4.6
- 1.4.5
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.1
- 1.3.0
- 1.2.1
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.0
- 0.12.1
- 0.12.0
- 0.11.2
- 0.11.1
- 0.11.0
- 0.10.5
- 0.10.4
- 0.10.3
- 0.10.2
- 0.10.1
- 0.10.0
- 0.9.6
- 0.9.5
- 0.9.4
- 0.9.3
- 0.9.2
- 0.9.1
- 0.9.0
- 0.8.1
- 0.8.0
- 0.7.2
- 0.7.1
- 0.7.0
- 0.6.12
- 0.6.11
- 0.6.10
- 0.6.9
- dev-dependabot/composer/league/commonmark-2.6.0
- dev-translations/polish-and-ukrainian
This package is auto-updated.
Last update: 2024-12-10 01:13:50 UTC
README
🏗 Formwork is a flat file-based Content Management System (CMS) to build and manage simple sites.
⚠️ This is the README
file for the 2.x
branch, currently in development and NOT STABLE.
👉 See the 1.x
branch for the latest stable version.
Features
- ⚡️ Lightweight
- 🗄 No database required!
- 📦 Easy to install
- ✨ Out-of-the-box Administration Panel
Requirements
- PHP 8.3 or higher
- PHP extensions
dom
,fileinfo
,gd
,mbstring
,openssl
andzip
Installing
From GitHub releases
You can download a ready-to-use .zip
archive from GitHub releases page and just extract it in the webroot of your server.
With Composer
If you prefer to install the latest stable release of Formwork with Composer you can use this command:
composer create-project getformwork/formwork
Composer will create a formwork
folder with a fresh ready-to-use Formwork installation.
To use the administration panel you need to build the assets.
Cloning from GitHub
If you want to get the currently worked master version, you can clone the GitHub repository and then install the dependencies with Composer.
- Clone the repository in your webroot:
git clone https://github.com/getformwork/formwork.git
- Navigate to
formwork
folder and install the dependencies:
cd formwork
composer install
- Build the administration panel assets.
Building administration panel assets with Yarn
After installing with Composer or cloning from GitHub, you need to build the panel assets with Yarn by running the following commands:
cd panel
yarn install
yarn build
Running Formwork server
You can test Formwork right away with the serve
command, a customized wrapper of the PHP Built-in web server.
Important
As with PHP CLI web server, Formwork server is intended for testing purposes and not for production environments.
Navigate to the formwork
folder and run the following command:
php bin/serve
If you prefer you can run the Formwork server through Composer:
composer serve