You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: public/components/fielddb/README.md
+26-17Lines changed: 26 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,33 +8,42 @@ FieldDB was officially launched in Spanish on August 1st 2012 in Patzun, Guatema
8
8
9
9
## Client apps/libraries:
10
10
11
-
There are quite a few client apps which use FieldDB api/corpora. Each project is designed with a particular user type (student, researcher, lab manager, scripter, power user) and context (field, lab, classroom) in mind. Each project has build/install/use instruction and example code in it's own README.md
11
+
There are quite a few client apps which use FieldDB api/corpora. Each project is designed with a particular user type (student, researcher, lab manager, scripter, power user) and context (field, lab, classroom) in mind. Each project has build/install/use instruction and example code in it's own README.md
12
12
13
13
* The [Prototype](https://github.com/FieldDB/FieldDB/tree/master/backbone_client) This app is where we prototyped all the features needed for collaborative data management of evolving data.<br>
* The [Spreadsheet](https://github.com/FieldDB/FieldDB/tree/master/angular_client/modules/spreadsheet) This is a student project to build an app that can be used with very little training or experience. It is focused on data entry and has only basic search/export/import/customization and can't handle large data sets. It has keybindings like a spreadsheets.
17
17
<br>
18
-
*[Dative](https://github.com/jrwdunham/dative) This app is designed for research teams who are going to be searching and cleaning their data, it is the next app to use after you find the Spreadsheet app too limited.
* The [Psycholinguistics Dashboard](https://github.com/ProjetDeRechercheSurLecriture/DyslexDisorthGame) This app is used to import participant lists and run experiements (games) and view their results.
22
-
* The [Psycholinguistics MontageJS library](https://github.com/ProjetDeRechercheSurLecriture/oprime-montage) This library has functionality for displaying/running and building experiements in the Montage.js framework.
24
-
* The [Activity Feed widget](https://github.com/FieldDB/FieldDB/tree/master/angular_client/modules/activity) This app lets you view the activity feed of a corpus.<br>
* The [Learn X app](https://github.com/FieldDB/AndroidLanguageLearningClientForFielddb) This is an Android app which lets you turn your corpus into a collaborative language learning app so that heritage speakers can use field methods to collect stories and analyze them.
* The Android [Elicitation Session Recorder](https://github.com/FieldDB/AndroidFieldDBElicitationRecorder) This app lets you record video sessions and upload them to the audio server for processing straight from your Android. This was also a student project and has a force closeon Android 4.4.
30
39
* The Android [Speech Recognition Trainer App](https://github.com/batumi/AndroidSpeechRecognitionTrainer) This app uses pocketsphinx on Android. It lets native speakers of low resource languages speak training data to their device which is used to build their voice model. Any corpus can be used as training data and as the data grows the user' language model improves and the app can recognize more words. We tested the app on ქართული (Georgian) we had little expectations for the recognition to work or be useable but we have reasonably okay results for SMS messages. This app can also be used for produciton experiments (it presents a visual and text representation which the user should read).<br>
* The [My Dictionary](https://github.com/FieldDB/DictionaryChromeExtension) This is a chrome extension which can be customized for any langauge which has a wiktionary. It is able to look up the word in the wiktionary and display the word's information to you on any website. Useful for browsing Facebook in your heritage language.
33
-
* The [Lexicon Browser](https://github.com/FieldDB/FieldDBLexicon) This app displays the lexicon of a corpus as a connected graph of morphemes. You can edit the morphemes, and clean the data where the morphemes are used. You can add discussion and linking between morphemes.
* The [Word Cloud Visualizer](https://github.com/FieldDB/FieldDBWordCloudChromeApp) This app uses D3 to display the words in a corpus in a word cloud. You can use this interface to lematize morphemes and play with the data in a frequency oriented way where the most frequent words pop out at the user.
$ 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
52
61
</pre>
53
62
54
63
## Core webservices:
55
64
56
-
These are the webservices which the FieldDB clients use, and which make up the complete FieldDB architecture. If you fork the project, you might also be intersted in forking these repositories and adapting them to your needs.
65
+
These are the webservices which the FieldDB clients use, and which make up the complete FieldDB architecture. If you fork the project, you might also be intersted in forking these repositories and adapting them to your needs.
57
66
58
67
*[Authentication webservice](https://github.com/FieldDB/AuthenticationWebService) (for creation of new users and their accounts on the various webservices)
59
68
*[FieldDB Webserver](https://github.com/FieldDB/FieldDBWebServer) (for public URLs)
@@ -84,9 +93,9 @@ Advanced way
84
93
85
94
1. Click on the "Fork" button to create your own copy.
86
95
1. Clone the code to your computer
87
-
1. 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`
88
-
89
-
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](https://github.com/FieldDB/FieldDB/issues).
96
+
1. 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`
97
+
98
+
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](https://github.com/FieldDB/FieldDB/issues).
90
99
1. 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.
91
100
1. Run `grunt watch` which will run the tests as you make changes.
92
101
1. Add failing tests for the change you want to make. Run `grunt test` to see the tests fail.
@@ -114,11 +123,11 @@ s
114
123
115
124
# Funding
116
125
117
-
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
126
+
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
118
127
119
-
# License
128
+
# License
120
129
121
-
This project is released under the [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) license, which is an very non-restrictive open source license which basically says you can adapt the code to any use you see fit.
130
+
This project is released under the [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) license, which is an very non-restrictive open source license which basically says you can adapt the code to any use you see fit.
0 commit comments