Jkan screenshot

Jkan

Author Avatar Theme by Timwis
Updated: 4 Feb 2025
223 Stars

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

Overview

JKAN is a lightweight, backend-free open data portal powered by Jekyll. It is designed to make the installation and maintenance of open-source data portals easier for small government agencies or resource-strapped organizations. The main purpose of JKAN is to provide a simple way to create an open data portal by leveraging the features of Jekyll, a static site generator.

Features

  • Backend-free: JKAN does not require a traditional backend system, making it lightweight and easy to manage.
  • Installation: JKAN offers a straightforward installation process, allowing users to set up their open data portal quickly.
  • Upgrading: Keeping the JKAN portal up to date is made simple through the provided upgrading guides.
  • Schema customization: Users have the ability to customize the data schema to fit their specific needs.
  • Running locally: JKAN can be easily run and tested locally before being deployed to a public server.
  • Demo site: A demo site is available to showcase the capabilities and features of JKAN.
  • Documentation: Extensive documentation is provided to guide users on how to use and customize JKAN.
  • Architecture: JKAN’s design and architecture are built on Jekyll, making it easy to understand and extend.

Installation

To install JKAN, follow these steps:

  1. Clone the JKAN repository from GitHub:
git clone https://github.com/timwis/jkan
cd jkan
  1. Install the necessary dependencies:
gem install jekyll
  1. Start Jekyll server:
jekyll serve
  1. Access JKAN in your preferred browser at http://localhost:4000.

Summary

JKAN is a user-friendly, backend-free open data portal solution powered by Jekyll. It simplifies the process of creating and maintaining open data portals, making it accessible to small government agencies or organizations with limited resources. With features such as easy installation, schema customization, and comprehensive documentation, JKAN offers a practical and efficient solution for managing open data.