Falaê is an Android app developed by HP volunteers from Brazil R&D in partnership with the NGO Educandário – Centro de Reabilitação São João Batista. It is an Alternative Communication app, that allows people with speech and mobility impairments to communicate by using pictures that represent words (verbs, nouns, adjectives…).
Falaê consists of two parts: Android app and the web platform. The web page is used for user registering. Once registered, the user can customize their profile, as well as create and modify communication boards, pages and items. The Android app connects to the web platform in order to sincronize the user's data.
This repository consists in the web server, that is developed with Ruby on Rails.
The Android App repository can be found here.
Feel free to fork or contribute this project.
Falaê is currently using ruby 3.0.6. It is recommend to use rbenv or rvm and install the version - you do not need to install both.
Full instructions available in https://github.com/rbenv/rbenv.
- Clone rbenv into
~/.rbenv
.
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
- Configure your shell to load rbenv:
echo 'eval "$(~/.rbenv/bin/rbenv init - bash)"' >> ~/.bashrc
- Source
.bashrc
file for changes to take effect:
source ~/.bashrc
- Clone rbenv-install plugin:
git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
-
Find instructions on how to install GPC keys to verify installation package and ensure security at https://rvm.io/rvm/install.
-
Type the following command into your terminal to install stable version of rvm:
curl -sSL https://get.rvm.io | bash -s stable
- Finally, type the following for rvm to detect dot files in the web folder. It will use the specified project ruby version or, it will warn if version is currently not installed. It also creates the gemset automatically.
cd .
Using rbenv
rbenv install 3.0.6
Using rvm
rvm install ruby-3.0.6
FALAE_IMAGES_PATH environment variable should be set for production enviroment to point to a directory where pictograms and user's images will be stored in. This variable should not point to the app's public directory, otherwise all files will be public accessible. It is optional for development environment, falling back to app storage directory.
export FALAE_IMAGES_PATH=<dir-name>
rvm @global do gem install bundler
Install gems:
bundle install
Run followig command if you are using rbenv
:
rbenv rehash
Set up local database
rails db:setup
Run the application
rails server
For development purposes, there is a useful rails task to populate the database with some pictogram samples.
rails pictograms:populate_with_samples
Notice both ruby
and rails
have system dependecies that must be installed depending on Operating System you are using.
- ImageMagick
- Depending on the OS, this library is installed by default. If not, you can find build and install instructions here.
MIT -- see LICENSE