Skip to content

Commit

Permalink
First commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
paulhibbitts committed Feb 28, 2016
0 parents commit f0304b2
Show file tree
Hide file tree
Showing 60 changed files with 1,173 additions and 0 deletions.
150 changes: 150 additions & 0 deletions .dependencies
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
git:
admin:
url: https://github.com/getgrav/grav-plugin-admin
path: user/plugins/admin
branch: master
archives:
url: https://github.com/getgrav/grav-plugin-archives
path: user/plugins/archives
branch: master
breadcrumbs:
url: https://github.com/getgrav/grav-plugin-breadcrumbs
path: user/plugins/breadcrumbs
branch: master
email:
url: https://github.com/getgrav/grav-plugin-email
path: user/plugins/email
branch: master
error:
url: https://github.com/getgrav/grav-plugin-error
path: user/plugins/error
branch: master
external_links:
url: https://github.com/Sommerregen/grav-plugin-external-links
path: user/plugins/external_links
branch: master
featherlight:
url: https://github.com/getgrav/grav-plugin-featherlight
path: user/plugins/featherlight
branch: master
feed:
url: https://github.com/getgrav/grav-plugin-feed
path: user/plugins/feed
branch: master
form:
url: https://github.com/getgrav/grav-plugin-form
path: user/plugins/form
branch: master
login:
url: https://github.com/getgrav/grav-plugin-login
path: user/plugins/login
branch: master
page-inject:
url: https://github.com/getgrav/grav-plugin-page-inject
path: user/plugins/page-inject
branch: master
pagination:
url: https://github.com/getgrav/grav-plugin-pagination
path: user/plugins/pagination
branch: master
problems:
url: https://github.com/getgrav/grav-plugin-problems
path: user/plugins/problems
branch: master
relatedpages:
url: https://github.com/getgrav/grav-plugin-relatedpages
path: user/plugins/relatedpages
branch: master
simplesearch:
url: https://github.com/getgrav/grav-plugin-simplesearch
path: user/plugins/simplesearch
branch: master
sitemap:
url: https://github.com/getgrav/grav-plugin-sitemap
path: user/plugins/sitemap
branch: master
taxonomylist:
url: https://github.com/getgrav/grav-plugin-taxonomylist
path: user/plugins/taxonomylist
branch: master
bones-vanilla:
url: https://github.com/smartgravity/grav-theme-bones-vanilla
path: user/themes/bones-vanilla
branch: master
course-companion-bv:
url: https://github.com/hibbitts-design/grav-theme-course-hub-bones
path: user/themes/course-hub-bones
branch: master
links:
admin:
src: grav-plugin-admin
path: user/plugins/admin
scm: github
archives:
src: grav-plugin-archives
path: user/plugins/archives
scm: github
breadcrumbs:
src: grav-plugin-breadcrumbs
path: user/plugins/breadcrumbs
scm: github
email:
src: grav-plugin-email
path: user/plugins/email
scm: github
error:
src: grav-plugin-error
path: user/plugins/error
scm: github
external_links:
src: grav-plugin-external_links
path: user/plugins/external_links
scm: github
featherlight:
src: grav-plugin-featherlight
path: user/plugins/featherlight
scm: github
feed:
src: grav-plugin-feed
path: user/plugins/feed
scm: github
form:
src: grav-plugin-form
path: user/plugins/form
scm: github
login:
src: grav-plugin-login
path: user/plugins/login
scm: github
page-inject:
src: grav-plugin-page-inject
path: user/plugins/page-inject
scm: github
pagination:
src: grav-plugin-pagination
path: user/plugins/pagination
scm: github
problems:
src: grav-plugin-problems
path: user/plugins/problems
scm: github
relatedpages:
src: grav-plugin-relatedpages
path: user/plugins/relatedpages
scm: github
simplesearch:
src: grav-plugin-simplesearch
path: user/plugins/simplesearch
scm: github
taxonomylist:
src: grav-plugin-taxonomylist
path: user/plugins/taxonomylist
scm: github
bones-vanilla:
src: grav-theme-bones-vanilla
path: user/themes/bones-vanilla
scm: github
course-companion-bv:
src: grav-theme-course-hub-bones
path: user/themes/course-hub-bones
scm: github
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Grav Specific
accounts/*
!accounts/.*
data/*
!data/.*
plugins/*
!plugins/.*
themes/*
!themes/.*

# OS Generated
.DS_Store*
thumbs.db
Icon?
Thumbs.db
*.swp
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# v0.9.6
## 03/01/2016

1. [](#new)
* ChangeLog started...
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2014 Grav

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
189 changes: 189 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
# Course Hub Skeleton

[![Demo](https://img.shields.io/badge/Demo-CourseHub-blue.svg?style=flat-square)](http://demo.hibbittsdesign.org/grav-course-hub-bones/)
[![License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://github.com/hibbitts-design/grav-skeleton-course-hub/blob/master/LICENSE)

[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/hibbitts-design/grav-skeleton-course-hub)

The **Course Hub** skeleton is intended to accompany a face-to-face, blended or fully online university course. It supports a [flipped-LMS approach](http://hibbittsdesign.org/blog/posts/flipped-lms-using-an-open-and-collaborative-platform) using the modern flat-file (no database) Grav CMS as an open and collaborative Web platform.

**Table of Contents**
[Why Flip your LMS with Grav?](#why-flip-your-lms-with-grav)
[Why Use a Modern flat-file CMS?](#why-use-a-modern-flat-file-cms)
[Course Hub Screenshot](#course-hub-screenshot)
[Course Hub Highlights](#course-hub-highlights)
[Quick Install (Web server only)](#quick-install-web-server-only)
[Recommended Install (Desktop + Server)](#recommended-install-desktop--server)
[Page Templates](#page-templates)
[Site Structure](#site-structure)
[Configuration](#site-configuration)

## Why Flip your LMS with Grav?
* To support pedagogical goals unmet by current LMS/platform
* To increase capability of access, sharing and collaboration
* To deliver a better student (and facilitator) experience

## Why Use a Modern flat-file CMS?
As an open source modern flat-file CMS, Grav offers a distinct set of advantages to Web-savvy educators looking to move beyond their institutional LMS:
* Modern means...
* Modern PHP code (i.e. reliability, speed, extensibility, etc.)
* Use of current standards (i.e. Markdown, Twig, YAML, etc.)
* Modular/customizable content chunks (i.e. reuse of content)
* Further separation of content (i.e. files) from presentation
* Flat-file means...
* No database means less (or no) IT involvement needed
* Content stored in text files rather than in a database
* Takes full advantage of the collaborative ecosystem now available (i.e. GitHub)
* Increased portability, as moving a site now only requires simply copying files to another location
* All template and content files are 100% version controllable

## Course Hub Screenshot
![Course Hub Screenshot](/assets/screenshot.jpg)
_Figure 1. Example Grav Course Hub website, with GitHub collaborative page editing enabled. Explore the demo online at [demo.hibbittsdesign.org/grav-course-hub/](http://demo.hibbittsdesign.org/grav-course-hub/)_

## Course Hub Highlights
* A complete ready-to-run Grav package (open source)
* Blog-format, with 'featured' (sticky) posts
* Important reminders & class preparations areas
* Site pages can be easily added/removed/changed
* Image header area above site navbar
* Sidebar is a simple markdown file, which can also contain HTML
* URL flag to only display page content (for display within LMS). For example, [http://demo.hibbittsdesign.org/grav-course-hub-bones/blog/week-03/onlydisplaypagecontent:true](http://demo.hibbittsdesign.org/grav-course-hub-bones/blog/week-03/onlydisplaypagecontent:true)
* External links are automatically opened in a new Tab/Window
* Built-in support for entire site to be collaboratively maintained on GitHub
* Since everything is built with Grav it can be _entirely_ customized

To learn more about how to most effectively use the Grav Course Hub, visit [hibbittdesign.org](http://hibbittsdesign.org/blog/)

## Quick Install (Web server only)
**Pre-flight Checklist**

1. Confirm Web server PHP version (PHP 5.5.9 or higher)
2. Web server login credentials (username and password)

**Installation Steps**

1. Download the ready-to-run [Course Hub Skeleton Package](http://hibbittsdesign.org/blog/downloads/grav-skeleton-course-hub-site.zip)
2. Unzip the package onto your desktop
3. Copy the entire Grav Course Hub folder to your Web server
4. Point your browser to the Web server folder
5. Create your site administrator account when prompted
6. And you're done! (press the ![Right Arrow Circle Icon](/assets/fa-arrow-circle-right.png) icon in the Admin Panel to preview site)

## Recommended Install (Desktop + Server)
With the flat-file (no database) nature of Grav, there are lots of benefits of installing Grav on your computer and then having your site files mirrored onto a Web server:
* Always have access to your site, regardless of Web server status
* Develop and test changes to your site privately without any downtime of the live site
* Store your site files on a Git service (i.e. GitHub) to better track your development and enable anywhere, anytime editing of your site
* Enable others (i.e. students, fellow instructors, colleagues, etc.) to collaboratively contribute to the site, including both site content _and_ code

![Grav recommended install using Grav, GitHub, and Deploy to support a flipped-LMS approach](/assets/flipped-lms-grav-github-deploy-2.png)
_Figure 2. Grav recommended install using Grav, GitHub, and Deploy to support a flipped-LMS approach._

**Pre-flight Checklist**

1. Confirm Web server PHP version (PHP 5.5.9 or higher)
2. Web server login credentials (username and password)
3. Download and install MAMP ([https://www.mamp.info/](https://www.mamp.info/))
4. Git server account (e.g. GitHub ([https://github.com/](https://github.com)) or local GitLab or Gogs app, etc.)
5. Download and install GitHub Desktop ([https://desktop.github.com/](https://desktop.github.com/))
6. Automatic deployment service (e.g. Deploy ([https://www.deployhq.com/](https://www.deployhq.com/)), FTPploy([https://ftploy.com/](https://ftploy.com/)), etc.)

**Desktop Installation Steps**

1. Download the ready-to-run [Course Hub Skeleton Package](http://hibbittsdesign.org/blog/downloads/grav-skeleton-course-hub-site.zip)
2. Unzip the Grav package onto your desktop
3. Create a folder called 'MAMP Websites' in your 'Documents' folder
4. Copy the _entire_ Grav folder into your 'MAMP Websites' folder
5. Launch MAMP
6. Change the 'Document Root' MAMP preferences setting to the 'MAMP Websites' folder (within 'Documents')
7. Press the MAMP 'Start Servers' button
8. Enter 'localhost:8888' as the URL in your Web Browser
9. Choose the displayed Grav folder name
10. Create your site administrator account when prompted
11. And you're done! (press the ![Right Arrow Circle Icon](/assets/fa-arrow-circle-right.png) icon in the Admin Panel to preview site)

Once you have confirmed that Grav is running locally on your computer, the final step is to create a Git server repository to store your site files and setup an automatic deployment service to push any changed files to your Web server. An example step-by-step walkthrough this process is available in the article [Using Grav with GitHub Desktop (and Deploy)](http://hibbittsdesign.org/blog/posts/using-grav-with-github-and-deploy).

## Page Templates
* Blog template (blog.html.twig)
* Important reminders template (important_reminders.html.twig)
* Weekly preparations template (preparations.html.twig)
* Blog item template (blog_item.html.twig)
* Item template (item.html.twig)
* Page template (page.html.twig)
* Sidebar template (sidebar.html.twig)

## Site Structure

```
/user
- /pages
- /01.blog | blog.html.twig and blog_item.html.twig
-/_important-reminders | important-reminders.html.twig
-/_class-preparations | class-preparations.html.twig
-/week-01 | item.html.twig
-/week-02 | item.html.twig
- etc..
- /02.resources | page.html.twig
-/page.md
- /03.syllabus | page.html.twig
-/page.md
- /sidebar | sidebar.html.twig
-/sidebar.md
- /headerimage | default.html.twig
-/default.md
- /footer | default.html.twig (Course Hub Bones theme element)
-/default.md
- /logo | default.html.twig (Course Hub Bones theme element)
-/default.md
- /mobilemenu | default.html.twig (Course Hub Bones theme element)
-/default.md
```

## Site Configuration
The 'site.yaml' file located in the '/user/config/' folder contains the following default values:
```
title: CPT-363
metadata:
description: 'A short description of your course would go here'
displaymenuentries:
enabled: false # display of additional menu entries
menu: # menu entry for adding external sites/tools
- text: Grav
icon: arrow-circle-right
url: http://getgrav.org/
icon: # default font awesome icons for preparation and post entries
post: calendar-o
github:
location: none # menu | page | none
tree: https://github.com/hibbitts-design/grav-skeleton-course-hub-bones/edit/master/
rssbutton:
display: true
```

| Setting | Child Setting | Description |
|---------|---------------|------------------------------------------------------------------------------------------------------------------------|
| title | | The course number/id, to be displayed at the top of every page. |
| metadata | description | The short description of the course hub site |
| displaymenuentries | enabled | Can be set to `true` or `false`. When set to `true`, all defined menu items are added to the navbar. |
| menu | text | Text label for external links to be included on navbar |
| menu | icon | Font awesome icon code for external link (optional) |
| menu | url | URL for external link|
| icon | post | Change the default font awesome icon for the weekly blog posts (i.e. weekly summaries). |
| rssbutton | display | Can be set to `true` or `false`. When set to `true`, it displays RSS buttons on the sidebar for each page. |
| github | location | Can be set to `page`, `menu` or `none`. When set to `page` or `menu`, it will display the **Edit this page** link to your GitHub repo in the indicated location. |
| github | tree | Sets the tree by which your site's content is based. Generally the repo your site's content is pulled from. |

#Blog Item Page Options

In addition to standard page header options (i.e. 'Visible'), blog item pages support the following additional options:
```
icon: users # optional font awesome icon for page title
header_image: false # display of header image located within page folder
continue_link: false # display entire post on blog listing page
taxonomy:
tag: Featured # setting to make post 'sticky' (i.e. remain at top)
```

---
Empty file added accounts/.gitkeep
Empty file.
Empty file added assets/.gitkeep
Empty file.
Binary file added assets/fa-arrow-circle-right.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/flipped-lms-grav-github-deploy-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f0304b2

Please sign in to comment.