A sign language dictionary
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
config
images
lib
priv
rel
test
.credo.exs
.gitignore
.iex.exs
.stylelintrc
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
Makefile
Procfile
README.md
mix.exs
mix.lock
upgrade.exs

README.md

SignDict.org

A crowdsourced sign language dictionary.

Build Status Coverage Status Join the chat at https://gitter.im/signdict/lobby

Here we will work on SignDict. A sign language dictionary where everyone can add new signs using their webcam. With this unique crowdsourcing approach we together can create the most accurate sign language dictionary there is.

You want to help? Awesome. Scroll through the issues, open a new one, join our Gitter Community or just send a short notice using the contact form. We are happy about every person who wants to help.

We also offer an API.

Development setup

SignDict uses Elixir and Phoenix. Information on how to install Elixir can be found here.

For the video transcoding it uses redis. On mac, install it via brew install redis-server, or sudo apt install redis-server for Linux and start it.

As database it uses PostgreSQL.

After you installed everything, the setup is as follows:

Mac instructions:

mix deps.get
mix ecto.setup
yarn
mix phoenix.server

Linux instructions:

Note: If you run into postgres password authentication errors, check out this blogpost for help.

mix deps.get
mix ecto.setup
sudo apt install npm
sudo npm install -g yarn
yarn
mix phoenix.server

With that you have a running system and a default admin user called admin@example.com with the password thepasswordisalie.

Before you contribute code, please make sure to read the CONTRIBUTING.md

In development mode Bamboo will not sent emails. Instead you can see what would have been sent out here: http://localhost:4000/sent_emails

This project is using yarn for javascript dependency management.

You can also use the included Procfile to start redis and the phoenix server at the same time. Install foreman with gem install foreman and execute foreman start to have both started automatically.

Deployment

The system is currently using bootleg to deploy the app. Simply call bootleg_user=USERNAME mix bootleg.update to deploy it to the production environment.

Funding

This project is government funded by the German Federal Ministry of Education and Research and is part of the 1st batch of the prototype fund.

Logo of the German Federal Ministry of Education and Research Prototype Fund Logo