Sitic has uploaded a new change for review. https://gerrit.wikimedia.org/r/210822
Change subject: Added README.md and .gitreview file ...................................................................... Added README.md and .gitreview file Documented how to install and develop crosswatch. Bug: T97899 Change-Id: I9d4f845331b0bc16177833bd8c58503d3c873b69 --- A .gitreview A README.md 2 files changed, 54 insertions(+), 0 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/labs/tools/crosswatch refs/changes/22/210822/1 diff --git a/.gitreview b/.gitreview new file mode 100644 index 0000000..263a949 --- /dev/null +++ b/.gitreview @@ -0,0 +1,5 @@ +[gerrit] +host=gerrit.wikimedia.org +port=29418 +project=labs/tools/crosswatch.git +defaultbranch=master diff --git a/README.md b/README.md new file mode 100644 index 0000000..9fff504 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# crosswatch + +Crosswatch is an enhanced cross-wiki watchlist for Wikimedia projects running at +[tools.wmflabs.org/crosswatch](http://tools.wmflabs.org/crosswatch/). + +It uses a Python based backend and a AngularJS based frontend. + +``` +git clone https://git.wikimedia.org/git/labs/tools/crosswatch.git +cd crosswatch +``` + +##Frontend +Install the local dependencies +``` +sudo npm install -g gulp bower +cd frontend +npm install +bower install +``` + +While developing use `gulp serve` to preview changes and `gulp build` to +build the application to `frontend/dist` for deployment. + +##Backend +Create a virtualenv and run +``` +cd backend +pip install -r requirements.txt +cp config.py.sample config.py +``` +Then change `config.py` to use your credentials. + +Start the Tornado webserver on `$PORT` with +``` +cd .. +python -m backend $PORT +``` +and the a celery worker: +``` +celery -A backend worker -l info +``` + +There are some helpful scripts if the tool runs on [Tool Labs](https://wikitech.wikimedia.org/wiki/Nova_Resource:Tools) in the `scripts` +directory. Change the name of the tool in `frontend/gulpfile.js` and +`backend/config.py` and the `scripts` files. + +#License +Licensed under [ISC](https://en.wikipedia.org/w/index.php?title=ISC_license&oldid=653545972) -- To view, visit https://gerrit.wikimedia.org/r/210822 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I9d4f845331b0bc16177833bd8c58503d3c873b69 Gerrit-PatchSet: 1 Gerrit-Project: labs/tools/crosswatch Gerrit-Branch: master Gerrit-Owner: Sitic <jan.leb...@online.de> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
