github2cocoon

Express.js middleware to use a github repository/branch as a zip file endpoint for the CocoonJS Launcher.

install

npm install --save github2cocoon

usage

with predefined username

This is the simplest use-case: when you only want to get zip archives from a single github user account (your own).

var express = require('express');
var app = express();
var github2cocoon = require("github2cocoon");
 
app.use(github2cocoon("zips", { username: "andyperlitch" }));
app.listen(80);

Then, put your server's endpoint url into the Launcher:

Notice how the URL is http://yourserver.com/[ROOT_DIR]/[REPO_URL]/[BRANCH_NAME].zip.

without a predefined username

Simply leave out the username option and the endpoints will be in the format: http://yourserver.com/[ROOT_DIR]/[USERNAME]/[REPO_URL]/[BRANCH_NAME].zip

motivation

Ludei's CocoonJS Launcher allows you to specify a URL endpoint for a zip containing your app. I wanted to use Github's archive endpoints (e.g. https://github.com/[USERNAME]/[REPO]/archive/[BRANCH].zip) for this purpose so that I could push to GH and then immediately test on my phone. This turns out not to work because Github packages the zip archive in a way that cocoon cannot find and execute the proper files. This middleware transforms the zip archive in a cocoon-compatible way.