Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 2.17 KB

fork-n-go.md

File metadata and controls

33 lines (19 loc) · 2.17 KB

Fork-n-Go

A Fork-n-Go project is a project on GitHub that in a few clicks, starting with a fork, gives another user a live website that they control with an easy to swap-for-your-own Google Spreadsheet database.

Two awesome things that make this possible: Forking, the tool on GitHub that allows you to copy a public repository onto your account, and GitHub Pages, GitHub's free web hosting service for every repository, account and organization.

I've built a whole other website on the idea with lots of examples: jlord.github.io/forkngo


How

To have a website for a repository hosted by GitHub Pages all you need is a branch named gh-pages. GitHub will then look in that branch for web files and serve them up at the address.

So Sheetsee.js projects, hosted on gh-pages branches on GitHub, can easily be forked and connected to another spreadsheet giving another user a live website of their own—with data they control—really easily.

Example

A Fork-n-Go example from my blog post on the topic:

Hack Spots Fork-n-Go

I made this website to collect hack spots all over the world from friends and friends of friends (the spreadsheet is wide open, so you can add some, too!). It’s using sheetsee to power the table, map and other elements of the page. Its source is in this repo, with just a gh-pages branch. To create an instance of this site for yourself all you need to do:

  • Create a Google spreadsheet with the same headers (just copy and paste header row from the original). Click File > Publish to Web, then Start Publishing.
  • Fork the original repository.
  • Edit the HTML file directly on GitHub.com to replace the original spreadsheet’s unique key with your spreadsheet’s key (found in your spreadsheet’s URL). Commit your change.

Now you have the same site connected to a spreadsheet that you manage — it’s live and can be found at yourGitHubName.github.io/theReposName.

forkcommit