README.md

Flask-SSE Demo

This is a very simple Flask-SSE demo, based on the Flask-SSE demo at bigboxcode - Flask Server Sent Events SSE.

Development was done using Github Codespaces.

whenNOTE: If you create a new Github Codespace based on this repository, then when Codespace starts up the following setup will be executed and the web server will start running.

To manually run this application:

1. Install requirements:

   Github Codespaces does this automatically, but if you are not using Github Codespaces:

   pip install Flask
   pip install gevent
   pip install gunicorn
   pip install Flask-SSE
   

2. Start a Redis instance (listening at default port 6379).

   On Github Codespaces, I created a script that runs a Docker instance of Redis. You can run the script:

   ./redis_docker.sh
   

   Or you can execute the following commands in the Github Codespaces terminal:

   docker pull redis
   docker run --rm --name local-redis -p 6379:6379 -d redis
   

3. Run the web server.

   I created a script that runs the Gunicorn web server on port 8000. You can run the script:

   ./run.sh
   

   Or you can execute the following command in the Github Codespaces terminal:

   gunicorn sse_app:app --worker-class gevent --bind 127.0.0.1:8000
   

4. If all goes well, load the website in a web browser. Go to:

   http://localhost:8000
   

5. Send POST JSON messages via the "publish" route, and it should be displayed in the web browser. You can do this using an app like "Postman".

   Example:

   POST to localhost:8000/publish

   {
       "id": 1,
       "test": "The quick brown fox jumps over the lazy dog.",
       "website": "https://github.com"
   }
   

   In the web browser you should now see the line:

   {"id": 1, "test": "The quick brown fox jumps over the lazy dog.", "website": "https://github.com"}
   

   You can keep POSTing more JSON to the "publish" route, and the web browser will append the data to the end.

   Enjoy!