Lackawanna is a cloud-based web application designed to facilitate social science researcher's work with qualitative data. Store all of your qualitative data in the cloud to easily access it wherever you are. Then transcribe and annotate these datapoints from any machine with a web browser.
- Upload, store and view research evidence (text, audio, video, PDFs)
- Retrieve webpages in their entirety and store them for later viewing
- Create multiple transcripts for datapoints
- Annotate transcripts and datapoints
- Full text search of datapoints, annotations, projects, collections, transcripts and tags
- Designed with extensibility in mind
- Built using best practices with documented code
- Easy to deploy (with Heroku)
- Flexible open source license (BSD)
Lackawanna uses Vagrant to simplify the creation of a reliable development environment. You can find a 'Getting Started' development guide in the docs/ directory in the repository
Please follow the deployment guide within the docs/ directory in the repository.
This project is fully open source so if you have suggestions or improvements please create an issue or make a pull request! Settings ------------
lackawanna relies extensively on environment settings which will not work with Apache/mod_wsgi setups. It has been deployed successfully with both Gunicorn/Nginx and even uWSGI/Nginx.
For configuration purposes, the following table maps the 'lackawanna' environment variables to their Django setting:
Environment Variable | Django Setting | Development Default | Production Default |
---|---|---|---|
DJANGO_AWS_ACCESS_KEY_ID | AWS_ACCESS_KEY_ID | n/a | raises error |
DJANGO_AWS_SECRET_ACCESS_KEY | AWS_SECRET_ACCESS_KEY | n/a | raises error |
DJANGO_AWS_STORAGE_BUCKET_NAME | AWS_STORAGE_BUCKET_NAME | n/a | raises error |
DJANGO_CACHES | CACHES | locmem | memcached |
DJANGO_DATABASES | DATABASES | See code | See code |
DJANGO_DEBUG | DEBUG | True | False |
DJANGO_EMAIL_BACKEND | EMAIL_BACKEND | django.core.mail.backends.console.EmailBackend | django.core.mail.backends.smtp.EmailBackend |
DJANGO_SECRET_KEY | SECRET_KEY | CHANGEME!!! | raises error |
DJANGO_SECURE_BROWSER_XSS_FILTER | SECURE_BROWSER_XSS_FILTER | n/a | True |
DJANGO_SECURE_SSL_REDIRECT | SECURE_SSL_REDIRECT | n/a | True |
DJANGO_SECURE_CONTENT_TYPE_NOSNIFF | SECURE_CONTENT_TYPE_NOSNIFF | n/a | True |
DJANGO_SECURE_FRAME_DENY | SECURE_FRAME_DENY | n/a | True |
DJANGO_SECURE_HSTS_INCLUDE_SUBDOMAINS | HSTS_INCLUDE_SUBDOMAINS | n/a | True |
DJANGO_SESSION_COOKIE_HTTPONLY | SESSION_COOKIE_HTTPONLY | n/a | True |
DJANGO_SESSION_COOKIE_SECURE | SESSION_COOKIE_SECURE | n/a | False |
- TODO: Add vendor-added settings in another table
The steps below will get you up and running with a local development environment. We assume you have the following installed:
- pip
- virtualenv
- PostgreSQL
First make sure to create and activate a virtualenv, then open a terminal at the project root and install the requirements for local development:
$ pip install -r requirements/local.txt
You can now run the usual Django runserver
command (replace yourapp
with the name of the directory containing the Django project):
$ python yourapp/manage.py runserver
The base app will run but you'll need to carry out a few steps to make the sign-up and login forms work. These are currently detailed in issue #39.
Live reloading and Sass CSS compilation
If you'd like to take advantage of live reloading and Sass / Compass CSS compilation you can do so with the included Grunt task.
Make sure that nodejs is installed. Then in the project root run:
$ npm install grunt
Now you just need:
$ grunt serve
The base app will now run as it would with the usual manage.py runserver
but with live reloading and Sass compilation enabled.
To get live reloading to work you'll probably need to install an appropriate browser extension
It's time to write the code!!!