Skip to content

Commit

Permalink
docs: document run.py vs readalongs/run.py
Browse files Browse the repository at this point in the history
  • Loading branch information
joanise committed Oct 5, 2021
1 parent 71b4918 commit e4e0794
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
8 changes: 8 additions & 0 deletions readalongs/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@
# It seems Werkzeug doesn't play well with SocketIO, so use SocketIO to run the app
# Watch this issue: https://github.com/miguelgrinberg/Flask-SocketIO/issues/894
#
# This file might seem redundant with ../run.py, but it's not: this here is invoked
# by "readalongs run", through click and Flask. Flask supplies the "run" command by
# default, using Werkzeug by default, bug we provide our overriding implementation
# here.
#
# By contrast, ../run.py can be invoked directly to manually run the app on a
# hard-coded port. This is also what is used by default in our Dockerfile.
#
######################################################################################

from readalongs.app import app, socketio
Expand Down
5 changes: 4 additions & 1 deletion run.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
#!/usr/bin/env python3

""" Run ReadAlong Studio as web application """
""" Run ReadAlong Studio as web application
Define the PORT environment variable to specify which port to use (default: 5000).
"""

import os

Expand Down

0 comments on commit e4e0794

Please sign in to comment.