https://github.com/CodeForPhilly/jawn

'Git for Tabular Data'
https://github.com/CodeForPhilly/jawn

Last synced: 3 months ago
JSON representation

'Git for Tabular Data'

• Host: GitHub
• URL: https://github.com/CodeForPhilly/jawn
• Owner: CodeForPhilly
• License: bsd-3-clause
• Created: 2016-02-07T17:26:42.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-06-23T01:31:13.000Z (over 8 years ago)
• Last Synced: 2024-05-16T13:18:52.506Z (8 months ago)
• Language: JavaScript
• Homepage: http://datjawn.com
• Size: 34.2 KB
• Stars: 44
• Watchers: 14
• Forks: 9
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-dat - jawn - distributed version control for tabular data, based on `hypercore` (Outdated / Other Related Dat Project Modules)
• awesome-starred - CodeForPhilly/jawn - 'Git for Tabular Data' (others)

README

        
# dat jawn: 'Git for Tabular Data'

[![Build Status](https://travis-ci.org/CfABrigadePhiladelphia/jawn.svg?branch=master)](https://travis-ci.org/CfABrigadePhiladelphia/jawn)

[![NPM](https://nodei.co/npm/jawn.png)](https://nodei.co/npm/jawn/)

Jawn is a node.js module that allows _distributed version control of Tabular Data_. It's connected to the [dat](https://github.com/maxogden/dat) project. It allows you to import tabular data (rows and columns like CSV or TSV) and track how those data change over time. _Do you have non-tabular data? read this:_ [What about Non Tabular Data?](https://github.com/CfABrigadePhiladelphia/jawn/wiki/What-about-Non-Tabular-Data%3F)  

The key features for jawn are to:

  * **manage and track change history** in tabular data

  * **create historical checkpoints** with metadata (e.g., message, timestamp, author)

Jawn relies on [hypercore](https://github.com/mafintosh/hypercore) to handle the core functions around creating merkle chains, which allows us to 

  * **supply access points to data** across the network with a peer-to-peer model

  * **sync incrementally** between machines

This is where jawn connects with the current work of the dat team, who created hypercore and are using it to do the same things with directories of files. For more background info, read our [Technical Background and Reference Code Bases](https://github.com/CfABrigadePhiladelphia/jawn/wiki/Technical-Background-and-Reference-Code-Bases) wiki page.

## Project Team

jawn is maintained by a [Code for Philly](https://codeforphilly.org) project that aims to be a model for mentorship and collaborative learning. For full information about the project go to the [jawn project page](https://codeforphilly.org/projects/dat_tables)  

We welcome contributions from anyone.

## Usage

_work in progress_

## Contributing

_work in progress_

If you want to work on the jawn code, first clone the repository and cd into that directory, then install the node dependencies and run the tests with these commands: 

```

npm install

npm test

```