No Description

bach bd4137e00d updated grav to 1.7.14 2 years ago
.github bd4137e00d updated grav to 1.7.14 2 years ago
.phan bd4137e00d updated grav to 1.7.14 2 years ago
assets bd4137e00d updated grav to 1.7.14 2 years ago
backup 8b139acd6e first commit 5 years ago
bin bd4137e00d updated grav to 1.7.14 2 years ago
cache 8b139acd6e first commit 5 years ago
images 8b139acd6e first commit 5 years ago
logs 8b139acd6e first commit 5 years ago
system bd4137e00d updated grav to 1.7.14 2 years ago
tests b857814072 maj grav 4 years ago
tmp c3e46357a3 added tmp to git ignore 4 years ago
user bd4137e00d updated grav to 1.7.14 2 years ago
webserver-configs bd4137e00d updated grav to 1.7.14 2 years ago
.dependencies 8b139acd6e first commit 5 years ago
.editorconfig b857814072 maj grav 4 years ago
.gitignore 3d5bc71a7c removed core plugins from git tree 2 years ago
.gitmodules f8b2b21c51 added plugin git submodule definition 2 years ago
.htaccess ba59f31741 loader ajax 4 years ago
.travis.yml b857814072 maj grav 4 years ago
CHANGELOG.md bd4137e00d updated grav to 1.7.14 2 years ago
CODE_OF_CONDUCT.md bd4137e00d updated grav to 1.7.14 2 years ago
CONTRIBUTING.md b857814072 maj grav 4 years ago
LICENSE.txt bd4137e00d updated grav to 1.7.14 2 years ago
README.md bd4137e00d updated grav to 1.7.14 2 years ago
SECURITY.md bd4137e00d updated grav to 1.7.14 2 years ago
codeception.yml 8b139acd6e first commit 5 years ago
composer.json bd4137e00d updated grav to 1.7.14 2 years ago
composer.lock bd4137e00d updated grav to 1.7.14 2 years ago
fixperms.sh 62fc885728 fixperms 2 years ago
index.php bd4137e00d updated grav to 1.7.14 2 years ago
now.json bd4137e00d updated grav to 1.7.14 2 years ago
robots.txt b857814072 maj grav 4 years ago

README.md

Grav

PHPStan SensioLabsInsight Discord PHP Tests 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]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [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