TextThresher

An annotation interface for detailed text annotation by crowdworkers along researcher-defined topics of interest. Under development for the Deciding Force Project. Currently, this app only runs locally.

Built with React and Redux.

To setup

The backend is supported by Docker. If you do not have it already, you will need to install it.

• For OS X, go here.
• For Windows, go here.
• For Ubuntu and other Linux distributions, install docker and docker-compose. To avoid having to use sudo when you use the docker command, create a Unix group called docker and add users to it:
  1. sudo groupadd docker
  2. sudo usermod -aG docker $USER

Once installed, start the Docker application (if on a Mac), then go to the project directory and run:

0. docker-compose build
1. docker-compose up -d
2. ./init_docker.sh
3. npm install
4. bower install
5. npm run dev

You will only need to run the above commands once. Those will do the preliminary setup for the application by installing the dependencies and seeding the Docker containers to setup the database.

Use docker-compose stop to stop the containers or docker-compose down to both stop and remove the containers.

To develop

You will have to refresh your containers depending on the types of changes that happen as you develop, or when you switch to another git branch.

If you are NOT CERTAIN what has changed in the current commit since the last time the containers were initialized and started, the most prudent course is to perform ALL of the following steps. If you want to take a shortcut, use the following table as a guide. But you should probably perform ALL the steps and then test your work before submitting a pull request.

To refresh your containers, first stop and remove them with:

0. docker-compose down

To view a browsable interface for the queries, navigate to localhost:5000/api/.

For easier front-end development, we recommend React Dev Tools and the Redux Dev Tools. Other install options for Redux DevTools are discussed in Redux DevTools Extension README.

Mac Note: If you encounter an error that the module text-highlighter/src/TextHighlighter cannot be found, you will need to update brew by running brew update.

To deploy

In the project dictory, run docker-compose start and npm run deploy. The output files will be written to the dist folder.

NOTE: this command currently currently not fully functional and needs to be upgraded. Running npm run dev instead will show the most recent version of the code.

To deploy the backend to Heroku:

• push the code to Heroku git push heroku

• Reset the db with heroku pg:reset postgres --confirm text-thresher

• Prepare the database. You have two options.

• To initialize the database but not load data, run heroku run python manage.py syncdb

• To initialize the database with a copy of your local data, verify that your local postgres database has data and works when you run the app locally, then run heroku pg:push LOCAL_DB_NAME postgres

• Visit the application to make sure it worked.