You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Matias Griese a7a9b5d132 Fixed a potential fatal error when using watermark in images 3 days ago
.github add php 8.1 to test (#3504) 4 months ago
.phan Add a .phan config file and stubs for Phan static analysis 3 years ago
assets updated copyright year 4 months ago
backup updated copyright year 4 months ago
bin Fixed `'mbstring' extension is not loaded` error, use Polyfill instead [#3504] 3 months ago
cache updated copyright year 4 months ago
images updated copyright year 4 months ago
logs updated copyright year 4 months ago
system Fixed a potential fatal error when using watermark in images 3 days ago
tests better fix 2 months ago
tmp updated copyright year 4 months ago
user simplify asset collections in a single array 4 months ago
webserver-configs Block `.json` files in web server configs 5 months ago
.dependencies Use quark by default 4 years ago
.editorconfig Minor indentation config tweaks 9 months ago
.gitignore ignore cli/security.yaml 9 months ago
.htaccess Block `.json` files in web server configs 5 months ago
.travis.yml 🎉 Moved Travis releases builds to Github Actions 🎉 1 year ago
CHANGELOG.md Fixed a potential fatal error when using watermark in images 3 days ago
CODE_OF_CONDUCT.md Updated COC to Contributor Covenant COC v2 1 year ago
CONTRIBUTING.md Remove Gitter, Slack (#2502) 3 years ago
LICENSE.txt Prepare for release 1 year ago
README.md Fixed pimple link #3527 3 months ago
SECURITY.md updated the security email 1 year ago
codeception.yml Updated unit tests 1 year ago
composer.json Revert accidental PHP requirement update 3 weeks ago
composer.lock Composer update 1 week ago
index.php Merge index exceptions with same handling 3 months ago
now.json Fixed version history issue 1 year ago
robots.txt updated robots.txt 1 year ago

README.md

Grav

PHPStan Discord PHP Tests OpenCollective OpenCollective OpenCollective

Grav is a Fast, Simple, and Flexible, file-based Web-platform. There is Zero installation required. Just extract the ZIP archive, and you are already up and running. It follows similar principles to other flat-file CMS platforms, but has a different design philosophy than most. Grav comes with a powerful Package Management System to allow for simple installation and upgrading of plugins and themes, as well as simple updating of Grav itself.

The underlying architecture of Grav is designed to use well-established and best-in-class technologies to ensure that Grav is simple to use and easy to extend. Some of these key technologies include:

Requirements

Documentation

The full documentation can be found from learn.getgrav.org.

QuickStart

These are the options to get Grav:

Downloading a Grav Package

You can download a ready-built package from the Downloads page on https://getgrav.org

With Composer

You can create a new project with the latest stable Grav release with the following command:

$ composer create-project getgrav/grav ~/webroot/grav

From GitHub

  1. Clone the Grav repository from https://github.com/getgrav/grav to a folder in the webroot of your server, e.g. ~/webroot/grav. Launch a terminal or console and navigate to the webroot folder:

    $ cd ~/webroot
    $ git clone https://github.com/getgrav/grav.git
    
  2. Install the plugin and theme dependencies by using the Grav CLI application bin/grav:

    $ cd ~/webroot/grav
    $ bin/grav install
    

Check out the install procedures for more information.

Adding Functionality

You can download plugins or themes manually from the appropriate tab on the Downloads page on https://getgrav.org, but the preferred solution is to use the Grav Package Manager or GPM:

$ bin/gpm index

This will display all the available plugins and then you can install one or more with:

$ bin/gpm install <plugin/theme>

Updating

To update Grav you should use the Grav Package Manager or GPM:

$ bin/gpm selfupgrade

To update plugins and themes:

$ bin/gpm update

Upgrading from older version

Contributing

We appreciate any contribution to Grav, whether it is related to bugs, grammar, or simply a suggestion or improvement! Please refer to the Contributing guide for more guidance on this topic.

Security issues

If you discover a possible security issue related to Grav or one of its plugins, please email the core team at contact@getgrav.org and we'll address it as soon as possible.

Getting Started

Exploring More

Backers

Support Grav with a monthly donation to help us continue development. [Become a backer]

Supporters

Support Grav with a monthly donation to help us continue development. [Become a supporter]

Sponsors

Support Grav with a yearly donation to help us continue development. [Become a sponsor]

License

See LICENSE

Running Tests

First install the dev dependencies by running composer install from the Grav root.

Then composer test will run the Unit Tests, which should be always executed successfully on any site. Windows users should use the composer test-windows command. You can also run a single unit test file, e.g. composer test tests/unit/Grav/Common/AssetsTest.php

To run phpstan tests, you should run:

  • composer phpstan for global tests
  • composer phpstan-framework for more strict tests
  • composer phpstan-plugins to test all installed plugins