From 7c0aaeac4f9c2c91211c04a823a926f4c96710b5 Mon Sep 17 00:00:00 2001 From: Eric Barbour Date: Aug 10 2016 19:35:20 +0000 Subject: Update README regarding Stream and Feed setup --- diff --git a/README.rst b/README.rst index 8b80f92..a7d2910 100644 --- a/README.rst +++ b/README.rst @@ -138,14 +138,27 @@ contents like this:: Make sure to leave the '' around you username and password - don't delete them! Some widgets will work without the above info being present.. but it is needed for a subset of them. -Feed Widget and My Stream - the Extra Mile +JavaScript assets +-------------- + +Some widgets and pages run on React so to install those dependencies:: + + $ cd hubs/static/client && npm install + +For the Feed and My Stream, change the ``SSE_URL`` location in the ``config`` you created +to point to the streaming server then build JavaScript assets. Add ``--w`` for live reloading:: + + $ cd hubs/static/client && node_modules/.bin/webpack + + +My Stream - the Extra Mile ------------------------------------------ -One widget (the big tamale -- the feed widget) and the My Stream page require more legwork to stand -up. If you just want to see how hubs works and you want to hack on other +One portion of Hubs - the My Stream page - requires more legwork to stand up. +If you just want to see how hubs works and you want to hack on other peripheral stuff around it, you don't need to bother with these steps. -The feed widget requires a direct DB connection to the datanommer +The stream requires a direct DB connection to the datanommer database; it can't proxy through datagrepper because it needs more flexibility. To get this working, you're going to set up: @@ -156,10 +169,6 @@ Start with some required packages:: $ sudo dnf install postgresql-server python-datanommer-consumer datanommer-commands fedmsg-hub npm -The Feed Widget runs on React so install those dependencies too:: - - $ cd hubs/static/client && npm install - And there are some support libraries you'll also need:: $ sudo dnf install python-psycopg2 python-fedmsg-meta-fedora-infrastructure @@ -217,19 +226,14 @@ will just grow and grow over time:: [2015-07-01 14:33:21][ fedmsg INFO] copr has 6 entries [2015-07-01 14:33:21][ fedmsg INFO] askbot has 2 entries -Change the ``SSE_URL`` location in ``default_config.py`` to point to the -streaming server then build JavaScript assets. Add ``--w`` for live reloading:: - - $ cd hubs/static/client && node_modules/.bin/webpack - **Lastly**, (fingers crossed) start up the fedora-hubs webapp and load your profile page. Change back to the project root and run:: $ python runserver.py -c config Once there are some messages that get into your local database -that *should* show up on your feed.. they should appear there. (At very least, -you shouldn't get an error message about that widget being unable to be +that *should* show up on your page. they should appear there. (At very least, +you shouldn't get an error message about that page being unable to be displayed). Stubbing out a new Widget