Full project documentation can be found on the wiki (https://github.com/slifty/newsquest/wiki).
This document explains how to set up the code.
If you have any questions at all please don't be afraid to ask (check the wiki to find where to ask).
Setting up the client and backend
-
Install Node.js (http://nodejs.org/)
-
Install MongoDB (http://www.mongodb.org/)
-
Using a terminal, navigate to the the same directory as this README)
-
Install the Express module (http://expressjs.com/guide.html)
-
Install the Jade module (https://github.com/visionmedia/jade#readme)
-
Install the MongoDB module (http://www.mongodb.org/display/DOCS/node.JS)
-
Install the Mongoose module (http://mongoosejs.com/)
-
Install the xml2js module (https://github.com/Leonidas-from-XIV/node-xml2js)
-
Create a local config file cp config.default.js config.js vi config.js
Please note that the brains for this (question generation) exists in a separate repository, location TBD.
-
start the mongo daemon
mongod
-
start the node server
node app.js
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.