Git Product home page Git Product logo

dkan2's Introduction

DKAN for Drupal 8 - Alpha

Maintainability Test Coverage

DKAN Open Data Portal/Catalog built on Drupal 8.

As a piece of software in its Alpha cycle, the code is continuously changing and in very active development.

Features

  • Harvesting of data from external catalogs that provide a data.json
  • Dataset metadata and resources
  • Web service API endpoints to work with datasets
  • Integration with a decoupled front end: Provided by Interra
  • A datastore to store CSV files and make them queryable through an SQL endpoint.

Requirements

  1. Install dkan-tools.
  2. Set an environment variable called DRUPAL_VERSION with a value of V8.
    1. On the command line, enter export DRUPAL_VERSION=V8 or set in .bashrc
  3. Setup and start the proxy:
    1. Add dkan to /etc/hosts
    2. Start the proxy: docker run -d -p 80:80 -v /var/run/docker.sock:/tmp/docker.sock:ro jwilder/nginx-proxy

Installation

  1. Create a directory for your project: mkdir <directory-name> && cd <directory-name>
  2. Initialize your project with dkan-tools: dktl init
  3. Get Drupal: dktl get <drupal-version>
  4. Get Drupal dependencies, and install DKAN: dktl make
  5. Install DKAN: dktl install
  6. Access the site: dktl drush uli --uri=dkan

Dummy Content

If you would like some content in the catalog, run the drush command dkan-dummy-content:create. This command required Drush 9.

Graphical User Interface (GUI)

DKAN for Drupal 8 is trying to work with independent pieces that can be used no only by us but any other open data catalog. With that goal, we are working with a decoupled React application as the frontend for DKAN.

The React App's README contains instruction on how to work with DKAN.

React App Embedded in Drupal

DKAN comes with an integration module that allows the React App driving the frontend to be embedded in Drupal.

To get the integration working follow these steps:

  1. Place the source for the Interra data-catalog-frontend in side of your docroot directory.
  2. Follow the instructions in the README of data-catalog-frontend, but instead of runnig the development server at the end, build a copy with npm run build
  3. Enable the integration module interra_frontend
  4. Change the sites configuration to point the homepage (/) to /home

dkan2's People

Contributors

acouch avatar dafeder avatar fmizzell avatar janette avatar ketwaroo avatar mmenavas avatar thierrydallacroce avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.