Skip to content

Survero - Perform literature surveys with ease (and with Zotero).

License

Notifications You must be signed in to change notification settings

StevenMHernandez/survero

Repository files navigation

Survero (Survey Web Application for Zotero)

Created by: Steven M. Hernandez

Screenshot of Survero

Zotero offers an easy method for collecting and reviewing research papers.
A special feature of zotero is that it produces a read-only .sqlite file which we can query for more complex analysis.

With this local database, I built a custom web application called Survero (survey+zotero) to make collecting notes, screenshots and search even easier!

To use this tool, first you will need to add the zotero.sqlite file from your local system. There are two options for adding the zotero.sqlite file into the project.

  1. Manually copy the sqlite database cp /Users/your_name/Zotero/zotero.sqlite ./volumes/zotero/ (on Mac)
  2. Setup a cronjob to automatically copy updates to zotero. Add the following to crontab -e: * * * * * /usr/bin/rsync -u /Users/your_name/Zotero/zotero.sqlite /your/full/path/to/survero/volumes/zotero (on Mac)

Next, you will want to edit the .env file:

cp ./.env-example ./.env 
vim ./.env

After this, you should be able to start survero through the terminal and open in a web browser.

# Start Survero
docker-compose up -d  # If there are problems, remove `-d` and watch the logs for any error messages.

The following tasks need to be run only the first time you start your server:

# Generate Encryption Key
docker-compose exec survero python craft key

# Create Database
docker-compose exec survero python craft migrate

Currently there is no easy way to create a new user. To register a new user open ./routes/web.py and uncomment the lines starting with:

Get("/register" ... and Post("/register" .... After this, head to http://localhost:12000/register to create a new account.

These paths are not enabled by default because we usually do not want people registering random accounts.

Create Your User

# Open in Browser
open http://localhost:12000

Survero stores all new data such as tags, screenshots-metadata in a new .sqlite file located at ./volumes/survero/survero.sqlite.

Updating Survero

When updating you may need to rerun migrations:

docker-compose exec survero craft migrate   

About

Survero - Perform literature surveys with ease (and with Zotero).

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published