2016-09-27 ~ Web Site via GitHub API

[theo-armour]

@jaanga/team-jaanga

The current test case is built for Jaanga Terrain3

More examples are in the works.

WebSite via GitHubAPI

Concept

GitHub repositories may contain hundreds of script files and supporting pages of content.

Finding out what is inside a repository can become a long and tedious process.

GitHub enables inspection and hosting via its GitHub pages feature

Making this work available as web pages can take time and effort away from programming and documenting.

The GitHub tools for setting up a content management system (CMS) require the use and knowledge of Ruby.

Setting up a remote server to set up a content management system for GitHub files takes time, effort and money.

Therefore:

A possible alternative is to have a client-side JavaScript app to act as a CMS

Mission

• Provide a simple client-side content management system for files in a gh-pages branch of a GitHub repository
• Written for non-programmers, non-designers - who want to code
• Write once. Read many
• Always a work-in-progress
• Always a bit more simple than it could be
  • It's easier to recover from no abstraction than the wrong abstraction

Vision

• Your coding process is auto-magically also your marketing process

Features

• Create a file explorer with menu
  • Display all folder and files of a repo in a directory-style tree
• Enable browsing and viewing of selected files.
  • Request details of all files in a gh-pages branch of a GitHub repository.
  • If a folder has an associated Read Me in Markdown format then display its contents as HTML
• Menu has breadcrumbs and other useful links
  • Display repo stats
  • Provide links to source code
  • Allow active users to enter their GitHub API key
  • Show users where they currently stand on usage limits
• Highlight recent updates
  • Lists tagged issues in right side menu
• View and act on the current contents
• Short, easy code
  • About 300 lines of mostly air
• Single dependency on ShowDown - a MarkDown interpreter