/jkan

A lightweight, backend-free open data portal, powered by Jekyll

Primary LanguageJavaScriptMIT LicenseMIT

JKAN Build Status Join the chat at https://gitter.im/timwis/jkan

A lightweight, backend-free open data portal, powered by Jekyll

Open-source data portals can be really. hard. to install and maintain. But their basic purpose of providing links to download data really isn't that complicated. JKAN is a proof-of-concept that allows a small, resource-strapped government agency to stand-up an open data portal by simply clicking the fork button.

Please note this is still a work in progress! Check out the issues to help out or give feedback.

Demo site

Installation

Just click "Fork" at the top-right of this page. (You'll need a GitHub account). You can then access it at <your_github_username>.github.io/jkan.

From there, you can use the built-in edit button on github to edit _config.yml and the datasets in the _datasets directory to manage your site.

Alternatively, you can use JKAN's user-friendly editing pages.

Screenshot of user-friendly editing page

But doing so requires one more installation step: setting up authentication. Fortunately there's a user-friendly page for doing that too. Just go to your setup page (ie. <your_github_username>.github.io/jkan/setup)

Screenshot of setup page

Development

  • Requires Jekyll, a ruby thing
  • Run a web server that recompiles on changes using jekyll serve --baseurl "". Add the experimental --incremental flag for faster recompilation.
  • Committing to the gh-pages branch will automatically compile the jekyll site