/songbook-api

TODO (see AnotherKamila/songbook-web)

Primary LanguagePythonMIT LicenseMIT

songbook-api

This is the backend/API for my songbook -- see the frontend's README for more info.

Heroku status Requirements Status Floobits Status

Development Quick Start

Note: This is the API server. The web frontend is AnotherKamila/songbook-web.

  • requires Python 3.4
  • first-time setup:
    1. create virtualenv: pyvenv ./venv (or pyvenv-3.4 ./venv)
    2. activate virtualenv:
      • bash, zsh: source venv/bin/activate
      • fish: . venv/bin/activate.fish
      • csh, tcsh: source venv/bin/activate.csh
    3. Install dependencies: pip install -r requirements.txt
  • always do stuff inside the venv (don't forget to activate it)
  • start server with python ./server.py (or heroku local)
    • automatically reloads when sources change
  • requires the REDISCLOUD_URL environment variable to be set to your Redis URL
  • read database.md for the data model and how stuff is stored