Repository: getgrav/grav
Stars: 15459
README.md
 Grav
   
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:
* Twig Templating: for powerful control of the user interface
* Markdown: for easy content creation
* YAML: for simple configuration
* Parsedown: for fast Markdown and Markdown Extra support
* Doctrine Cache: layer for performance
* Pimple Dependency Injection Container: for extensibility and maintainability
* Symfony Event Dispatcher: for plugin event handling
* Symfony Console: for CLI interface
* Gregwar Image Library: for dynamic image manipulation
Requirements
- PHP 7.3.6 or higher. Check the required modules list
- Check the Apache or IIS 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/gravFrom 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.git2. Install the plugin and theme dependencies by using the Grav CLI application bin/grav:
cd ~/webroot/grav
bin/grav installCheck 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 indexThis 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 selfupgradeTo update plugins and themes:
bin/gpm updateUpgrading from older version
* Upgrading to Grav 1.7
* Upgrading to Grav 1.6
* Upgrading from Grav <1.6
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 [email protected] and we'll address it as soon as possible.
Getting Started
* What is Grav?
* Install Grav in few seconds
* Understand the Configuration
* Take a peek at our available free Skeletons
* If you have questions, jump on our Discord Chat Server!
* Have fun!
Exploring More
* Have a look at our Basic Tutorial
* Dive into more advanced functions
* Learn about the Grav CLI
* Review examples in the Grav Cookbook
* More Awesome Grav Stuff
Backers
Support Grav with a monthly donation to help us continue development. [Become a backer]
<img src="https://opencollective.com/grav/tiers/backers.svg?avatarHeight=36&width=600" />
Supporters
Support Grav with a monthly donation to help us continue development. [Become a supporter]
<img src="https://opencollective.com/grav/tiers/supporters.svg?avatarHeight=36&width=600" />
Sponsors
Support Grav with a yearly donation to help us continue development. [Become a sponsor]
<img src="https://opencollective.com/grav/tiers/sponsors.svg?avatarHeight=36&width=600" />
License
See LICENSE
[gitflow-model]: http://nvie.com/posts/a-successful-git-branching-model/
[gitflow-extensions]: https://github.com/nvie/gitflow
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