Home

Awesome

GitHub package version JavaScript Style Guide vue-recommended-style Travis Build Status Appveyor Build status Appveyor Acceptance Test status

Unit Test Coverage Status Github All Releases Github Releases

:sparkles: Download Data Curator for Windows or macOS. :sparkles: Request a new feature :bulb: Report a bug :beetle: View our plans :rocket: Now available through the Microsoft Windows Store. :department_store:

Data Curator

data curator icon

Data Curator is a simple desktop data editor to help describe, validate and share usable open data.

Why do we need Data Curator?

Open data creators are increasingly focusing on improving open data publishing so that data can be used to create insight and drive positive change.

Open data is more likely to be used if data consumers can:

Features

Using Data Curator open data producers can:

Using data from any of these sources, you can:

Once the data is described and validated, you can share the data and its description by exporting a Data Package to:

Open data consumers can use published Data Packages to:

data curator screen shot

Follow our progress

Interested in this project? Subscribe to Data Curator News to get occasional updates on our progress and hear about each release. Find help.

Contributions

We welcome all types of contributions to Data Curator:

We acknowledge the great work of others. We are:

Our privacy policy : Data Curator Privacy Policy

Data Curator proudly uses open source software, including:

softwareorganisationlicencesupport
Comma ChameleonThe Open Data InstituteMITjoin
datapackage.jsOpen KnowledgeMITdonate
tableschema-jsOpen KnowledgeMITdonate
ElectronGitHubMITcontribute
Node.jsNode.jslicencecontribute
ChromiumThe Chromium Authorslicencecontribute
Vue.jsYuxi (Evan) YouMITdonate
electron-vueSimulatedGREG (Greg Holguin)MITcontribute
HandsontableHandsontableMITbuy pro
Cucumber.jsCucumber.ioMITcontribute

Download and Install Data Curator


Development

We develop against the 'develop' branch. The 'master' branch contains tagged releases. We are currently using this branching model by Vincent Driessen.

Requirements

node<br> yarn<br> electron

You can use yarn to install all relevant packages and development dependencies. (Install yarn)

We're keeping our dependencies up to date with Dependabot.

Running the application locally

To open the app on your local machine and run Data Curator in development mode:

Data Curator will launch with an extra Developer menu.

data curator developer mode

Application Architecture

Data Curator is built using Electron, a framework that allows developers to build desktop applications using web technology.

There are two parts of the application, the main process and the renderer process. The main process deals with things like carrying out file operations, validating CSVs, and rendering views. The renderer acts very much like client side javascript in a web browser, dealing with things like presentation, and user interactions.

IPC messaging

Electron passes and listens for messages between main and renderer using the IPC module, one for the main process and one for the renderer process.

Coding Standards

We have adopted Standard JS as our JavaScript coding standard.

We have adopted Recommended Vue as our Vue coding standard.

JavaScript Style Guide

Tests

Acceptance tests

Acceptance tests for Data Curator are:

Acceptance tests are automatically added to Cucumber Pro via a GitHub webhook.

Unit tests

For unit testing, we use:

Continuous integration

For continuous integration, we use:

We plan to integrate the acceptance and unit tests with code commits

To run unit tests and implemented acceptance tests:

yarn run test

Deployment

Building a new package

To build Data Curator locally:

yarn run build

To automate deployment, we are using:

To trigger the automated build and draft release, create and push a git tag, following the versioning pattern used in current releases. Ensure that any changes in this tag are also released back to develop and master branches.

Changes are recorded on the Releases page.