README.md

FieldDB is a free, modular, open source project developed collectively by field linguists and software developers to make an expandable user-friendly app which can be used to collect, search and share your data, both online and offline. It is fundamentally an app written in 100% Javascript which runs entirely client side, backed by a NoSQL database (we are currently using CouchDB and its offline browser wrapper PouchDB alpha). It has a number of webservices which it connects to in order to allow users to perform tasks which require the internet/cloud (ie, syncing data between devices and users, sharing data publicly, running CPU intensive processes to analyze/extract/search audio/video/text). While the app was designed for "field linguists" it can be used by anyone collecting text/audio/video data or collecting highly structured data where the fields on each data point require encryption and/or customization from user to user, and where the schema/structure of the data is expected to evolve over the course of data collection while in the "field."

FieldDB was officially launched in Spanish on August 1st 2012 in Patzun, Guatemala as iCampo an app for fieldlinguists. Since then more than 500 users at 50+ universities that we know of have started using and giving us feedback about the app. You can find more about the "non-technical" side of the project at LingSync.org or find "technical" publications about the project on the Dev site. You can also watch screencasts which demo how parts of the app & infrastructure work by searching on YouTube.

Interns and Development Team

• Louisa Bielig (McGill)
• M.E. Cathcart (U Delaware)
• Gina Chiodo (iLanguage Lab Ltd)
• Theresa Deering (Visit Scotland, Aquafadas)
• Joel Dunham (Concordia, UBC)
• Josh Horner (Amilia)
• Yuliya Manyakina (McGill)
• Elise McClay (McGill)
• Hisako Noguchi (Concordia)
• Jesse Pollak (Pomona College)
• Tobin Skinner (Amilia, McGill)
• Xianli Sun (Miami University)

Funding

We would like to thank SSHRC Connection Grant (#611-2012-0001) and SSHRC Standard Research Grant (#410-2011-2401) which advocates open-source approaches to knowledge mobilization and partially funded the students who have doubled as fieldwork research assistants and interns on the project. We would like to thank numerous other granting agencies which have funded the RAs and TAs who have also contributed to the project as interns. If you have a student/RA who you would like to customize the project for your needs, contact us at support @ lingsync . org

License

This project is released under the Apache 2.0 license, which is an very non-restrictive open source license which basically says you can adapt the code to any use you see fit.

How to Help

We are very friendly and welcome newbies to learn more about scripting and data processing. We use Javascript for almost everything in the project so that it is easier for non-programmers to learn how to program so feel free to ask us questions or make feature requests. We will help you figure out if you can do that feature or at least work on part of it.

Easy way

1. Signup for a GitHub account (GitHub is free for OpenSource)
2. Click on the "Fork" button to create your own copy.
3. Leave us a note in our issue tracker to tell us a bit about the feature/bug you want to work on.
4. You can follow the 4 GitHub Help Tutorials to install and use Git on your computer.
5. Feel free to ask us questions in our issue tracker, we're friendly and welcome Open Source newbies.
6. Clone the code to your computer (you can use the GitHub Desktop app).
7. You can watch/search the videos on YouTube dev playlist and/or in the Developer's Blog to find out how the codebase works, and to find where is the code that you want to edit. You might also like the user tutorial screencasts to see how the app is supposed to behave. Feel free to ask us questions in our issue tracker, we're friendly and welcome Open Source newbies.
8. Search for a word or string that will help you find the relevant code on your computer (We use Sublime Text which helps alot). Edit the code on your computer, commit your changes referencing the issue #xxxx you created ("fixes #xxxx i changed blah blah...") and click Sync in the GitHub app to sync changes to your origin.
9. Click on the "Pull Request" button, and leave us a note about what you changed. We will look at your changes and help you bring them into the project!

Advanced way

1. Click on the "Fork" button to create your own copy.
2. Clone the code to your computer
3. You should also try to run the tests $ npm install and $ grunt test it should say something like Finished in 10.388 seconds 732 tests, 2308 assertions, 0 failures, 0 skipped Then you can also run the entire build $ grunt travis to make sure your changes dont affect other parts of the app. If any of these parts errors, ask us for help in the issue tracker.
4. Create a new branch for new fixes or features, this is easier to build a fix/feature specific pull request than if you work in your master branch directly.
5. Run grunt watch which will run the tests as you make changes.
6. Add failing tests for the change you want to make. Run grunt test to see the tests fail.
7. Fix stuff.
8. Look at the terminal output (assuming you ran grunt watch) to see if the tests pass. Repeat steps 2-4 until done.
9. Open $ open tests/SpecRunner.html unit test file(s) in actual browser(s) (Chrome Canary, Firefox, Safari) to ensure tests pass everywhere.
10. Update the documentation to reflect any changes.
11. Push to your fork and submit a pull request and leave us a note about what you changed. We will look at your changes and help you bring them into the project!

Related repositories

These are the webservices which the FieldDB clients use, and which make up the complete FieldDB suite. If you fork the project, you might also be intersted in forking these repositories and adapting them to your needs. We created two scripts to simplify the process of downloading and building the FieldDB dependancies into one directory.

• Mac developer script

$ cd $HOME/Downloads && curl -O --retry 999 --retry-max-time 0 -C - https://raw.githubusercontent.com/FieldDB/FieldDB/master/install_mac_download_and_set_up_fielddb_servers_for_new_developers_quick_start.sh && bash install_mac_download_and_set_up_fielddb_servers_for_new_developers_quick_start.sh

• Linux developer script

$ cd $HOME/Downloads && wget https://raw.githubusercontent.com/FieldDB/FieldDB/master/install_linux_download_and_set_up_fielddb_servers_for_new_developers_quick_start.sh && bash install_linux_download_and_set_up_fielddb_servers_for_new_developers_quick_start.sh

Core webservices:

• Authentication webservice (for creation of new users and their accounts on the various webservices)
• FieldDB Webserver (for public URLs)
• Database webservice (we are using pure CouchDB for this webservice)

Optional webservices

• Audio webservice (for hosting audio files and running processes such as the ProsodyLab's Aligner)
• Lexicon webservice (for search functionality, and glosser functionality if you are a linguist)

Client apps/libraries:

You might also be interested in the code for some of the client apps which use FieldDB api/corpora.

• The Prototype
  

* The [Spreadsheet](https://github.com/FieldDB/FieldDB/tree/master/angular_client/modules/spreadsheet)  * [Dative](https://github.com/jrwdunham/dative)  * The [Psycholinguistics Dashboard](https://github.com/ProjetDeRechercheSurLecriture/DyslexDisorthGame)  * The [Psycholinguistics MontageJS library](https://github.com/ProjetDeRechercheSurLecriture/oprime-montage)  * The [Activity Feed widget](https://github.com/FieldDB/FieldDB/tree/master/angular_client/modules/activity)

* The [Learn X app](https://github.com/FieldDB/AndroidLanguageLearningClientForFielddb)  * The Android [Elicitation Session Recorder](https://github.com/FieldDB/AndroidFieldDBElicitationRecorder) * The Android [Speech Recognition Trainer App](https://github.com/batumi/AndroidSpeechRecognitionTrainer)

* The [My Dictionary](https://github.com/FieldDB/DictionaryChromeExtension) Chrome extension  * The [Lexicon Browser](https://github.com/FieldDB/FieldDBLexicon)  * The [Word Cloud Visualizer](https://github.com/FieldDB/FieldDBWordCloudChromeApp)  * You can [add others](https://github.com/FieldDB/FieldDB/edit/master/README.md) if there any missing in this list...