Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dativebase/dative

Dative: software for linguistic fieldwork
https://github.com/dativebase/dative

coffeescript linguistics spa

Last synced: 3 months ago
JSON representation

Dative: software for linguistic fieldwork

Awesome Lists containing this project

README 

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

# Dative



## Description



Dative is a graphical interface for linguistic fieldwork and language

documentation applications. At present, Dative works with the [Online

Linguistic Database (OLD)](http://www.onlinelinguisticdatabase.org). For more

information, see the [Dative web site](http://www.dative.ca).



## Features



- Collaboration and data sharing

- Advanced and smart search

- Automatic morpheme cross-referencing

- Build morphological parsers and phonologies

- CSV import

- Text creation

- Media file (i.e., audio, video, image)-to-text association.

- User access control

- Documentation

- Open source



![Screenshot of Dative](dative-screenshot.png)



## For Developers



Dative is open source and under active development.



### Technologies



- Backbone

- CoffeeScript

- Mocha/Chai tests

- Grunt task automation



### Install



Dative has become old and unloved. It is currently difficult to build. For this

reason, I am releasing pre-built versions of Dative---i.e., directory structures

each containing a single, concatenated and minified JavaScript file along with

the needed static files (images, CSS, etc.) and dependency licenses---under

subdirectories of ``releases/``.



To test out a pre-built Dative, extract the release, move into its directory, and

use Python to serve it locally at ``http://0.0.0.0:8000/``::



    $ cd releases/

    $ tar -zxvf release-.tar.gz

    $ cd release-/

    $ python3 -m http.server



#### Original Install Instructions



First, make sure you have NodeJS >= 0.10 installed. Then install the Grunt

command line interface (CLI):



    $ sudo npm install -g grunt-cli



Then clone the dative repo and move into the clone:



    $ git clone https://github.com/jrwdunham/dative.git

    $ cd dative



Then install the dependencies:



    $ yarn



Then optionally install the test dependencies:



    $ cd test

    $ yarn

    $ cd ..



### Serve, test, build, etc.



To serve the app with livereload, run:



    $ grunt serve



The serve task generates source map files that Chrome's developer tools can

recognize. This means that you can view the CoffeeScript source in the browser

and can set breakpoints, etc. For some docs on CoffeeScript source maps and

JavaScript debugging in Chrome, see:



- http://www.html5rocks.com/en/tutorials/developertools/sourcemaps/

- https://developer.chrome.com/devtools/docs/javascript-debugging



To run the tests and view the Mocha print-out in the browser, run:



    $ grunt serve:test



After running the above command, the browser will automatically refresh

whenever a source file or a test file is saved. This allows you to code with

constant updates showing which tests are passing.



To build the app in the dist/ directory:



    $ grunt build



To build the app in the dist/ directory and serve the result:



    $ grunt serve:dist



To validate the CoffeeScript using coffeelint:



    $ grunt lint



To run the tests and view the results in the command line (*currently

not working*):



    $ grunt test



To generate the docco HTML docs using the comments in your source files:



    $ grunt docs



The above command generates files in the docs/ directory. Because docco

overwrites files of the same name in different directories, I have configured

the Gruntfile to rename each file for doc generation using the file's path.