2017 © Pedro Peláez
 

project grav

Modern, Crazy Fast, Ridiculously Easy and Amazingly Powerful Flat-File CMS

image

getgrav/grav

Modern, Crazy Fast, Ridiculously Easy and Amazingly Powerful Flat-File CMS

  • Friday, July 27, 2018
  • by rhukster
  • Repository
  • 412 Watchers
  • 9348 Stars
  • 24,927 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 920 Forks
  • 222 Open issues
  • 100 Versions
  • 7 % Grown

The README.md

Grav

PHPStan Discord PHP Tests OpenCollective OpenCollective OpenCollective, (*1)

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., (*2)

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:, (*3)

Requirements

Documentation

The full documentation can be found from learn.getgrav.org., (*4)

QuickStart

These are the options to get Grav:, (*5)

Downloading a Grav Package

You can download a ready-built package from the Downloads page on https://getgrav.org, (*6)

With Composer

You can create a new project with the latest stable Grav release with the following command:, (*7)

$ 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:, (*8)

    $ 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:, (*9)

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

Check out the install procedures for more information., (*10)

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:, (*11)

$ bin/gpm index

This will display all the available plugins and then you can install one or more with:, (*12)

$ bin/gpm install <plugin/theme>

Updating

To update Grav you should use the Grav Package Manager or GPM:, (*13)

$ bin/gpm selfupgrade

To update plugins and themes:, (*14)

$ 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., (*15)

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., (*16)

Getting Started

Exploring More

Backers

Support Grav with a monthly donation to help us continue development. [Become a backer], (*17)

, (*18)

Supporters

Support Grav with a monthly donation to help us continue development. [Become a supporter], (*19)

, (*20)

Sponsors

Support Grav with a yearly donation to help us continue development. [Become a sponsor], (*21)

, (*22)

License

See LICENSE, (*23)

Running Tests

First install the dev dependencies by running composer install from the Grav root., (*24)

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, (*25)

To run phpstan tests, you should run:, (*26)

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

The Versions