Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
activity
app
audio_video
authentication
bot
comment
confidentiality_encryption
corpus
data_list
datum
docs
export
glosser
hotkey
image
images
import
insert_unicode
lessons_corpus
libs
locales
permission
search
test
user
.bowerrc
.jshintrc
README.md
SpecRunner.html
background.js
backup_pouches.html
backup_pouches_dashboard.js
bower.json
build_backup_pouches_dashboard.js
build_corpus_online_dashboard.js
build_user_online_dashboard.js
build_welcome_online_dashboard.js
corpus.html
corpus_dashboard.js
corpus_online_dashboard.js
favicon.ico
index.html
lingllama_dashboard.js
manifest.json
manifest_dev.json
manifest_dev_packaged.json
manifest_local.json
manifest_miami.json
package.json
sorry.html
sorry.js
user.html
user_dashboard.js
user_online_dashboard.js
welcome_dashboard.js
welcome_online_dashboard.js

README.md

This is the backbone client, where most of the code base was in 2012. Since then we have ported this code to CommonJS so that it can be used in any Javascript framework.

You can see the Prototype in action by installing it from the Chrome Store

screen shot 2015-02-20 at 3 04 33 pm

screen shot 2015-02-20 at 3 05 44 pm

You can run this code in 3 ways:

Chrome Extension

If you want to debug the app, this is the best way to go. You can modify the source, refresh the browser and you have the new code. To install this app go to chrome://chrome/extensions, check 'developer mode', then click on 'Load unpacked extensions...' and select the subfolder _attachments here.

If you get a blank black screen, look at the developer console and if it says

Failed to load resource chrome-extension://chpphlmbdnlddgbhiplfpolgfhpadfip/libs/compiled_handlebars.js

you will need to go to the top level folder (above this folder), do

$ cd FieldDB
$ npm install
$ bash scripts/build_templates.sh

(you need to do this only once when you first download the codebase, and run build_templates.sh every time you change the handlebars templates)

Desktop App

You can build this into a Mac, Windows or Linux app using NW.js

cd node_modules
git clone https://github.com/Gisto/nwjs-shell-builder.git
cd ../
rm -rf ~/git/nwjs-shell-builder/TMP
~/git/nwjs-shell-builder/nwjs-build.sh  \
  --src=/Users/gina/fielddbhome/FieldDB/backbone_client  \
  --nw=0.13.0-beta5  \
  --name=LingSync  \
  --win-icon=/Users/gina/fielddbhome/FieldDB/raw/icon.ico  \
  --osx-icon=/Users/gina/fielddbhome/FieldDB/raw/icon.icns  \
  --target="5" \
  --build

CouchApp

If you want to deploy the app so that it can run online on URL, the fastest way is to push it to a couchdb. You can use the couchapp_prototype folder, and the build_fielddb_minified.sh script.

Android App

If you want to run the app as an Native Android app you can use the AndroidFieldDB project, combined with the build_release_android.sh script.

Running on Android is farely complex as it requires you to set up 5 Android libraries, 3 for TouchDB (a local http server which implements the couchdb API) and 2 for OPrime (an offline Android data management/psycholinguistics experimentation library).

Release History

For up-to-date details see the milestones

  • December 2014 work began on Dative which will replace both the Spreadsheet and the Prototype as the default app
  • December 2013 was replaced with the Spreadhseet app for field methods classes
  • January 2013 became online by default (so that students wouldnt have to learn how to use the sync buttons)
  • August 2012 launched at the CAML workshop videos

Related apps

If you are interested in the Prototype app, you might be interested in some other client apps which also use FieldDB.