=============================== Aspectual Annotator

.. image:: https://badges.greenkeeper.io/wroberts/annotator.svg :alt: Greenkeeper badge :target: https://greenkeeper.io/

.. image:: https://travis-ci.org/wroberts/annotator.svg?branch=master :target: https://travis-ci.org/wroberts/annotator

Web app for aspectual annotation.

Final Resource

The annotated corpus and annotation guidelines can be downloaded in the file aspectual-corpus.zip <aspectual-corpus.zip>_.

Quickstart

First, set your app's secret key as an environment variable. For example, add the following to .bashrc or .bash_profile.

.. code-block:: bash

export ANNOTATOR_SECRET='something-really-secret'

Before running shell commands, set the FLASK_APP and FLASK_DEBUG environment variables ::

export FLASK_APP=$PWD/autoapp.py
export FLASK_DEBUG=1

Then run the following commands to bootstrap your environment ::

git clone https://github.com/wroberts/annotator
cd annotator
pip install -r requirements/dev.txt
npm install
npm start  # run the webpack dev server
flask run  # run the flask server

To deploy::

export FLASK_DEBUG=0
npm run build
flask run

You will see a pretty welcome screen.

Once you have installed your DBMS, run the following to create your app's database tables and perform the initial migration ::

flask db init
flask db migrate
flask db upgrade
flask run

Deployment

In your production environment, make sure the FLASK_DEBUG environment variable is unset or is set to 0, so that ProdConfig is used.

Shell

To open the interactive shell, run ::

flask shell

By default, you will have access to the flask app.

Running Tests

To run all tests, run ::

flask test

Migrations

Whenever a database migration needs to be made. Run the following commands ::

flask db migrate

This will generate a new migration script. Then run ::

flask db upgrade

To apply the migration.

For a full migration command reference, run flask db --help.