Welcome to TextScrollServer’s documentation!

Build passed Coverage Status Documentation

TextScrollServer

The backend server for the TextScroll application.

How to get up and running for development

  1. Start a virtual environment
$ pip install virtualenv
$ virtualenv TextScroll --no-site-packages
$ .\TextScroll\Scripts\activate
  1. Install dependencies
(TextScroll) $ pip install -r requirements.txt
  1. Install MongoDB.
  2. Develop on a feature branch
(TextScroll) $ git branch feature/feature_name
  1. Commit and push your changes.
  2. Check the build and coverage status on Travis and Coveralls
  3. When ready, open a Pull Request.

Contents:

Indices and tables