FinSL-signbank documentation

Date:Jan 05, 2019
Version:1.0.0

FinSL-signbank is a Django web framework based application for managing sign language lexicons.

Contents:

Features

  • Keep your sign language lexicon organized.
    • Have as many lexicons as you like.
    • Control user permissions per lexicon.
    • Publish your lexicons to be viewed by the public.
  • Create Glosses and attach many kinds of data into them.
    • Videos: Record videos with a webcam in the app, or simply upload from your computer.
    • Translation equivalents in any language(s) you want.
    • Relationships between Glosses.
    • Sign language, notes, URLs, comments, etc.
  • Separate user interfaces for viewing and editing detailed gloss data, and a non-editable interface for the public.
  • Export you lexicon to be used with annotation of videos with ELAN.
  • The user interface is translated into several languages.
    • You can create translations for any language.
  • View complete version history of Glosses and revert changes when needed.
  • See a network graph of relationships between glosses per lexicon.

Requirements

  • Python 3.4
  • Django 1.11
  • PostgreSQL (or MySQL, SQLite3)
  • Apache+mod_wsgi (or nginx)

Python dependencies are listed in requirements.txt:

django==1.11.18
django-tagging==0.4.6
django-reversion==2.0.13
django-bootstrap3==11.0.0
django-summernote==0.8.8.8
django-modeltranslation==0.12.2
django-registration==2.4.1
django-contrib-comments==1.9.0
django-guardian==1.4.9
django-notifications-hq==1.4

JavaScript dependencies are listed in package.json:

{
  "name": "finsl-signbank",
  "version": "1.0.0",
  "description": "sign language lexicon database",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "collectjs": "cp -f ./node_modules/*/dist/*min.js ./signbank/static/js && cp -f ./node_modules/recordrtc/RecordRTC.min.js ./signbank/static/js && cp -f ./node_modules/at.js/dist/js/jquery.atwho.min.js ./signbank/static/js && cp -f ./node_modules/cookieconsent/build/cookieconsent.min.js ./signbank/static/js && cp -f ./node_modules/sigma/build/sigma.min.js ./signbank/static/js && cp -f ./node_modules/sigma/build/plugins/sigma.layout.forceAtlas2.min.js ./signbank/static/js",
    "collectcss": "cp -f ./node_modules/at.js/dist/css/jquery.atwho.min.css ./signbank/static/css && cp -rf ./node_modules/bootstrap/dist/* ./signbank/static/bootstrap/ && cp -f ./node_modules/cookieconsent/build/cookieconsent.min.css ./signbank/static/css"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/Signbank/FinSL-signbank.git"
  },
  "keywords": [
    "signlanguage"
  ],
  "author": "Henri Nieminen",
  "license": "BSD-3-Clause",
  "bugs": {
    "url": "https://github.com/Signbank/FinSL-signbank/issues"
  },
  "homepage": "https://github.com/Signbank/FinSL-signbank#readme",
  "dependencies": {},
  "devDependencies": {
    "TagManager": "git+https://github.com/max-favilli/tagmanager.git",
    "at.js": "^1.5.4",
    "bootstrap": "^3.3.7",
    "jquery": "^3.3.1",
    "jquery.caret": "^0.3.1",
    "mark.js": "^8.11.1",
    "recordrtc": "^5.4.6",
    "sigma": "^1.2.1",
    "typeahead.js": "^0.11.1",
    "cookieconsent": "^3.0.6"
  }
}

Installation (in short)

  1. Install with pip: pip install finsl-signbank.
  2. Edit settings files.
  3. Migrate: python bin/develop.py migrate

Note

See Installation and Settings for more detailed instructions.