No Description

Bachir Soussi Chiadmi e41c207dd6 updated quark theme 1 week ago
assets 7689c4ccbf grav installed 1 month ago
backup 7689c4ccbf grav installed 1 month ago
bin 7689c4ccbf grav installed 1 month ago
cache 7689c4ccbf grav installed 1 month ago
images 7689c4ccbf grav installed 1 month ago
logs 7689c4ccbf grav installed 1 month ago
system eb30f395bc updated core 1 week ago
tests 7689c4ccbf grav installed 1 month ago
tmp 7689c4ccbf grav installed 1 month ago
user e41c207dd6 updated quark theme 1 week ago
webserver-configs 7689c4ccbf grav installed 1 month ago
.dependencies 7689c4ccbf grav installed 1 month ago
.editorconfig 7689c4ccbf grav installed 1 month ago
.gitignore 0bb7582c98 ignoring system.yalm config file 3 weeks ago
.gitmodules 06841bf527 installed admin plugin 1 month ago
.htaccess 7689c4ccbf grav installed 1 month ago
.travis.yml 7689c4ccbf grav installed 1 month ago
CHANGELOG.md eb30f395bc updated core 1 week ago
CODE_OF_CONDUCT.md 7689c4ccbf grav installed 1 month ago
CONTRIBUTING.md 7689c4ccbf grav installed 1 month ago
LICENSE.txt 7689c4ccbf grav installed 1 month ago
README.md 7689c4ccbf grav installed 1 month ago
codeception.yml 7689c4ccbf grav installed 1 month ago
composer.json 7689c4ccbf grav installed 1 month ago
composer.lock 7689c4ccbf grav installed 1 month ago
fixperms.sh 3958f5f0fe added fixperms.sh script 1 month ago
index.php 7689c4ccbf grav installed 1 month ago
robots.txt 7689c4ccbf grav installed 1 month ago

README.md

Grav

SensioLabsInsight Slack Build Status 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

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

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 update 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