Commit 4013c59d authored by Goutte's avatar Goutte

Enhance the installation instructions.

The local backoffice of Grav can be used to craft courses.
This is inspiring!
parent 4aa37706
......@@ -5,8 +5,15 @@ These are the sources of an instance of Grav tailored for the courses of M3P2.
The plugins and themes are included.
Only the php vendors are not included.
## Run locally for fast development
PHP `7.1` (or above) is recommended. Do tell us what works or not for you.
Clone this repository:
git clone --recursive https://m3p2.ljbac.com/m3p2/grav-website.git m3p2-html-generator
Install dependencies:
bin/grav install
......@@ -17,7 +24,8 @@ Then try out
to troubleshoot.
Add the courses from the other repository
Add the courses from the other repository, if you did not use `git clone --recursive`:
bin/clone_courses.sh
......@@ -27,6 +35,10 @@ And run locally
php -S localhost:8000 system/router.php
At this point, you should be asked to set admin credentials.
These will allow you to access the `/admin` section of the website.
## Mirror the courses to generate a static website
This may come in handy when we'll want offline access
......@@ -46,7 +58,7 @@ Since our plugins and themes are in this repository, they are frozen.
So far, Grav itself is safe to update, as well as all plugins **but mathjax** (until they merge our MR).
Todo: look up .dependencies and perhaps we'll remove the plugins dir altogether from this repository.
Waiting for future Grav updates to specify deps more elegantly (they're working on it at this time).
The theme `textbook` is tailored for M3P2 courses.
The plugin `gitlab-markdown-adapter` was expressly made for this Grav instance.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment