mirror of
https://github.com/getformwork/formwork.git
synced 2025-01-17 13:38:22 +01:00
55 lines
2.2 KiB
Markdown
55 lines
2.2 KiB
Markdown
# <img src="admin/assets/images/icon.svg" height="28"> Formwork
|
|
|
|
[![Discord](https://img.shields.io/discord/637658168754831380?color=%237289da&label=chat&logo=discord&logoColor=%23fff)](https://discord.gg/5Q3BmNY)
|
|
[![GitHub Release Date](https://img.shields.io/github/release-date/getformwork/formwork.svg)](https://github.com/getformwork/formwork/releases/latest)
|
|
[![GitHub All Releases](https://img.shields.io/github/downloads/getformwork/formwork/total.svg)](https://github.com/getformwork/formwork/releases)
|
|
[![Packagist](https://img.shields.io/packagist/dt/getformwork/formwork.svg?color=%23f28d1a&label=Packagist%20downloads)](https://packagist.org/packages/getformwork/formwork)
|
|
[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/getformwork/formwork.svg)]()
|
|
[![PHP from Packagist](https://img.shields.io/packagist/php-v/getformwork/formwork.svg)](#requirements)
|
|
|
|
Formwork is a flat file-based Content Management System (CMS) to make and manage simple sites.
|
|
|
|
Latest version: [**1.11.0**](https://github.com/getformwork/formwork/releases/latest) | [**Changelog**](CHANGELOG.md)
|
|
|
|
## Features
|
|
- ⚡️ Lightweight
|
|
- 🗄 No database required!
|
|
- 📦 Easy to [install](#installing)
|
|
- ✨ Out-of-the-box Administration Panel
|
|
|
|
![](assets/images/formwork.png)
|
|
|
|
## Requirements
|
|
- PHP **7.3.5** or higher
|
|
- PHP extensions `fileinfo`, `gd`, `mbstring` and `zip`
|
|
|
|
## Installing
|
|
|
|
### From GitHub releases
|
|
You can download a ready-to-use `.zip` archive from [GitHub releases page](https://github.com/getformwork/formwork/releases) 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](https://getcomposer.org/) you can use this command:
|
|
|
|
```
|
|
$ composer create-project getformwork/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/getformwork/formwork.git
|
|
```
|
|
|
|
2. Navigate to `formwork` folder and install the dependencies:
|
|
|
|
```
|
|
$ cd formwork
|
|
$ composer install
|
|
```
|