Unsophisticated stream-style indieweb reader supporting h-feed and xml formats
Python CSS JavaScript Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
frontend
scripts
woodwind
.gitignore
LICENSE
NOTES.md
README.md
config.py.template
deploy.sh
fabfile.py
init_db.py
log.sh
requirements.txt
run.py
setup.py
timers.py
vacuum.sql
woodwind-dev.ini
woodwind-sock.ini
woodwind.cfg.template
woodwind.ini

README.md

Woodwind

Requirements Status

A minimum viable stream-style feed reader.

Supports mf2 h-feed and xml feeds (thanks to Universal Feed Parser).

Installation

How to run your own instance of Woodwind. You'll first need to make sure you have Postgres and Redis installed and running.

git clone https://github.com/kylewm/woodwind.git
cd woodwind

Set up the virtualenv and install dependencies.

virtualenv --python=/usr/bin/python3 venv
source venv/bin/activate
pip install -r requirements.txt

Copy woodwind.cfg.template to woodwind.cfg and edit it to check the Postgres connection string.

Then create database tables and run Woodwind.

# create the postgres database
createdb woodwind
# copy and edit the configuration file
cp woodwind.cfg.template woodwind.cfg
nano woodwind.cfg
# create the database tables
python init_db.py
# finally run the application
uwsgi woodwind-dev.ini

Now visit localhost:3000, and you should see the login screen!