|
1 | | -# Drupal Commerce Documentation |
| 1 | +#  Grav |
2 | 2 |
|
3 | | -**Contents:** |
4 | | -- [How to contribute to this documentation](#how-to-contribute-to-this-documentation) |
5 | | - - [Before your first contribution](#before-your-first-contribution) |
6 | | - - [Fast online contribution](#fast-online-contribution) |
7 | | - - [Local setup](#local-setup) |
| 3 | +[](https://github.com/phpstan/phpstan) |
| 4 | +[](https://insight.sensiolabs.com/projects/cfd20465-d0f8-4a0a-8444-467f5b5f16ad) |
| 5 | +[](https://chat.getgrav.org) |
| 6 | + [](https://travis-ci.org/getgrav/grav) [](#backers) [](#sponsors) |
8 | 7 |
|
9 | | -## How to contribute to this documentation |
| 8 | +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. |
10 | 9 |
|
11 | | -### Before your first contribution |
| 10 | +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: |
12 | 11 |
|
13 | | -**Before contributing**, you should consider the following: |
14 | | -- The documentation is written using [reStructuredText](http://docutils.sourceforge.net/rst.html) markup language. If you are not familiar with this format, read [this article](https://symfony.com/doc/current/contributing/documentation/format.html) for a quick overview of its basic features. |
15 | | -- The documentation is hosted on [GitHub](https://github.com). You'll need a free GitHub user account to contribute to the documentation. |
16 | | -- The documentation is published under a [Creative Commons BY-SA 4.0 License](https://github.com/drupalcommerce/commerce-docs/blob/master/LICENSE) and all your contributions will implicitly adhere to that license. |
| 12 | +* [Twig Templating](https://twig.sensiolabs.org/): for powerful control of the user interface |
| 13 | +* [Markdown](https://en.wikipedia.org/wiki/Markdown): for easy content creation |
| 14 | +* [YAML](https://yaml.org): for simple configuration |
| 15 | +* [Parsedown](https://parsedown.org/): for fast Markdown and Markdown Extra support |
| 16 | +* [Doctrine Cache](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/caching.html): layer for performance |
| 17 | +* [Pimple Dependency Injection Container](https://pimple.sensiolabs.org/): for extensibility and maintainability |
| 18 | +* [Symfony Event Dispatcher](https://symfony.com/doc/current/components/event_dispatcher/introduction.html): for plugin event handling |
| 19 | +* [Symfony Console](https://symfony.com/doc/current/components/console/introduction.html): for CLI interface |
| 20 | +* [Gregwar Image Library](https://github.com/Gregwar/Image): for dynamic image manipulation |
17 | 21 |
|
18 | | -### Fast online contribution |
| 22 | +# Requirements |
19 | 23 |
|
20 | | -If you're making a relatively small change - like fixing a typo or rewording something - the easiest way to contribute is directly on GitHub! You can do this while you're reading this documentation. |
| 24 | +- PHP 7.1.3 or higher. Check the [required modules list](https://learn.getgrav.org/basics/requirements#php-requirements) |
| 25 | +- Check the [Apache](https://learn.getgrav.org/basics/requirements#apache-requirements) or [IIS](https://learn.getgrav.org/basics/requirements#iis-requirements) requirements |
21 | 26 |
|
22 | | -1. Click on the **Edit on GitHub** button on the upper right corner and you'll be redirected to GitHub:  |
23 | | -2. Click the **edit icon** to edit the documentation:  |
24 | | -3. You will be asked to fork the repo, click **Fork this repository and propose changes**:  |
25 | | -4. Edit the contents, describe your changes and click on the **Propose file change** button:  |
26 | | -5. GitHub will now create a branch and a commit for your changes (forking the repository first if this is your first contribution) and it will also display a preview of your changes: If everything is correct, click on the **Create pull request** button. |
27 | | -6. GitHub will display a new page where you can do some last-minute changes to your pull request before creating it. For simple contributions, you can safely ignore these options and just click on the **Create pull request** button again. |
| 27 | +# QuickStart |
28 | 28 |
|
29 | | -**Congratulations!** You just created a pull request to the official Drupal Commerce documentation! The community will now review your pull request and (possibly) suggest tweaks. |
| 29 | +These are the options to get Grav: |
30 | 30 |
|
31 | | -But if you want to contribute heavily, we recommend you doing a local setup of the documentation. |
| 31 | +### Downloading a Grav Package |
32 | 32 |
|
33 | | -### Local setup |
34 | | -1. Run composer install |
35 | | -7. In the terminal generate user for admin panel `bin/plugin login newuser` |
36 | | -8. Add credentials |
37 | | - |
38 | | -9. Login `php -S localhost:8000 system/router.php` |
| 33 | +You can download a **ready-built** package from the [Downloads page on https://getgrav.org](https://getgrav.org/downloads) |
39 | 34 |
|
40 | | -### Edit using Visual Code Studio |
41 | | -You can download Visual Code Studio and add the [reStructured Text](https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext) plugin to have an editor with built in previews available. |
| 35 | +### With Composer |
42 | 36 |
|
43 | | -### Edit and review manually |
44 | | -1. Execute `./build.sh`, this will generate documentation HTML inside `_build/html`. |
45 | | -2. Now you can view the documentation locally, execute `php -S localhost:8000 -t _build/html` , and visit [http://localhost:8000/](http://localhost:8000/) from your browser. |
| 37 | +You can create a new project with the latest **stable** Grav release with the following command: |
46 | 38 |
|
47 | | -That's it! |
| 39 | +``` |
| 40 | +$ composer create-project getgrav/grav ~/webroot/grav |
| 41 | +``` |
| 42 | + |
| 43 | +### From GitHub |
| 44 | + |
| 45 | +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: |
| 46 | + ``` |
| 47 | + $ cd ~/webroot |
| 48 | + $ git clone https://github.com/getgrav/grav.git |
| 49 | + ``` |
| 50 | + |
| 51 | +2. Install the **plugin** and **theme dependencies** by using the [Grav CLI application](https://learn.getgrav.org/advanced/grav-cli) `bin/grav`: |
| 52 | + ``` |
| 53 | + $ cd ~/webroot/grav |
| 54 | + $ bin/grav install |
| 55 | + ``` |
| 56 | + |
| 57 | +Check out the [install procedures](https://learn.getgrav.org/basics/installation) for more information. |
| 58 | + |
| 59 | +# Adding Functionality |
| 60 | + |
| 61 | +You can download [plugins](https://getgrav.org/downloads/plugins) or [themes](https://getgrav.org/downloads/themes) manually from the appropriate tab on the [Downloads page on https://getgrav.org](https://getgrav.org/downloads), but the preferred solution is to use the [Grav Package Manager](https://learn.getgrav.org/advanced/grav-gpm) or `GPM`: |
| 62 | + |
| 63 | +``` |
| 64 | +$ bin/gpm index |
| 65 | +``` |
| 66 | + |
| 67 | +This will display all the available plugins and then you can install one or more with: |
| 68 | + |
| 69 | +``` |
| 70 | +$ bin/gpm install <plugin/theme> |
| 71 | +``` |
| 72 | + |
| 73 | +# Updating |
| 74 | + |
| 75 | +To update Grav you should use the [Grav Package Manager](https://learn.getgrav.org/advanced/grav-gpm) or `GPM`: |
| 76 | + |
| 77 | +``` |
| 78 | +$ bin/gpm selfupgrade |
| 79 | +``` |
| 80 | + |
| 81 | +To update plugins and themes: |
| 82 | + |
| 83 | +``` |
| 84 | +$ bin/gpm update |
| 85 | +``` |
| 86 | + |
| 87 | + |
| 88 | +# Contributing |
| 89 | +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](CONTRIBUTING.md) for more guidance on this topic. |
| 90 | + |
| 91 | +## Security issues |
| 92 | +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. |
| 93 | + |
| 94 | +# Getting Started |
| 95 | + |
| 96 | +* [What is Grav?](https://learn.getgrav.org/basics/what-is-grav) |
| 97 | +* [Install](https://learn.getgrav.org/basics/installation) Grav in few seconds |
| 98 | +* Understand the [Configuration](https://learn.getgrav.org/basics/grav-configuration) |
| 99 | +* Take a peek at our available free [Skeletons](https://getgrav.org/downloads/skeletons) |
| 100 | +* If you have questions, jump on our [Discord Chat Server](https://chat.getgrav.org)! |
| 101 | +* Have fun! |
| 102 | + |
| 103 | +# Exploring More |
| 104 | + |
| 105 | +* Have a look at our [Basic Tutorial](https://learn.getgrav.org/basics/basic-tutorial) |
| 106 | +* Dive into more [advanced](https://learn.getgrav.org/advanced) functions |
| 107 | +* Learn about the [Grav CLI](https://learn.getgrav.org/cli-console/grav-cli) |
| 108 | +* Review examples in the [Grav Cookbook](https://learn.getgrav.org/cookbook) |
| 109 | +* More [Awesome Grav Stuff](https://github.com/getgrav/awesome-grav) |
| 110 | + |
| 111 | +# Backers |
| 112 | +Support Grav with a monthly donation to help us continue development. [[Become a backer](https://opencollective.com/grav#backer)] |
| 113 | + |
| 114 | +<img src="https://opencollective.com/grav/tiers/backers.svg?avatarHeight=36&width=600" /> |
| 115 | + |
| 116 | +# Sponsors |
| 117 | +Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/grav#sponsor)] |
| 118 | + |
| 119 | +<img src="https://opencollective.com/grav/tiers/sponsors.svg?avatarHeight=36&width=600" /> |
| 120 | + |
| 121 | +# License |
| 122 | + |
| 123 | +See [LICENSE](LICENSE.txt) |
| 124 | + |
| 125 | + |
| 126 | +[gitflow-model]: http://nvie.com/posts/a-successful-git-branching-model/ |
| 127 | +[gitflow-extensions]: https://github.com/nvie/gitflow |
| 128 | + |
| 129 | +# Running Tests |
| 130 | + |
| 131 | +First install the dev dependencies by running `composer update` from the Grav root. |
| 132 | +Then `composer test` will run the Unit Tests, which should be always executed successfully on any site. |
| 133 | +Windows users should use the `composer test-windows` command. |
| 134 | +You can also run a single unit test file, e.g. `composer test tests/unit/Grav/Common/AssetsTest.php` |
0 commit comments