formwork/README.md

48 lines
1.4 KiB
Markdown
Raw Normal View History

2018-06-16 16:41:58 +02:00
# Formwork
2019-03-04 21:29:55 +01:00
Formwork is a flat file-based Content Management System (CMS) to make and manage simple sites.
2018-06-16 16:41:58 +02:00
2019-03-18 12:22:28 +01:00
Latest version: [**0.10.1**](https://github.com/giuscris/formwork/releases/tag/0.10.1) | [**Changelog**](CHANGELOG.md)
2018-07-10 17:26:32 +02:00
2018-06-16 16:41:58 +02:00
## Features
2019-03-04 21:29:55 +01:00
* ⚡️ Lightweight Core (~350 kB dependencies included)
2018-07-18 17:57:55 +02:00
* 🗄 No database required!
* 📑 Simple file-based Cache system
* ✨ Out-of-the-box Administration Panel
2018-06-16 16:41:58 +02:00
![](assets/images/formwork.png)
2018-07-10 17:26:32 +02:00
## Requirements
2018-10-06 19:53:35 +02:00
* PHP 5.6.0 or higher
2018-09-12 14:48:12 +02:00
* PHP `zip` extension
2018-10-06 19:53:35 +02:00
* PHP `gd` extension
2019-03-20 12:19:31 +01:00
## Installing
### From GitHub releases
You can download a ready-to-use `.zip` archive from [GitHub releases page](https://github.com/giuscris/formwork/releases) and just extract it in your webroot of your server.
### With Composer
If you prefer to install the latest stable release of Formwork with [Composer](https://getcomposer.org/) you can use this command:
```
$ composer create-project giuscris/formwork
```
Composer will create a `formwork` folder with a fresh ready-to-use Formwork installation.
### 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.
1. Clone the repository in your webroot:
```
$ git clone https://github.com/giuscris/formwork.git
```
2. Navigate to `formwork` folder and install the dependencies:
```
$ cd formwork
$ composer install
```