From 7142b69259d0eebe62586c3221067107fec45aca Mon Sep 17 00:00:00 2001 From: Rocky Duan Date: Mon, 13 Aug 2012 16:12:09 -0700 Subject: [PATCH] instructions for setting up the environment --- doc/discussion.md | 119 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 119 insertions(+) create mode 100644 doc/discussion.md diff --git a/doc/discussion.md b/doc/discussion.md new file mode 100644 index 0000000000..52357674a0 --- /dev/null +++ b/doc/discussion.md @@ -0,0 +1,119 @@ +# Running the discussion service + +## Instruction for Mac + +## Installing Mongodb + +If you haven't done so already: + + brew install mongodb + +Make sure that you have mongodb running. You can simply open a new terminal tab and type: + + mongod + +## Installing elasticsearch + + brew install elasticsearch + +For debugging, it's often more convenient to have elasticsearch running in a terminal tab instead of in background. To do so, simply open a new terminal tab and then type: + + elasticsearch -f + +## Setting up the discussion service + +First, make sure that you have access to the [github repository](https://github.com/rll/cs_comments_service). If this were not the case, send an email to dementrock@gmail.com. + +First go into the mitx_all directory. Then type + + git clone git@github.com:rll/cs_comments_service.git + cd cs_comments_service/ + +If you see a prompt asking "Do you wish to trust this .rvmrc file?", type "y" + +Now if you see this error "Gemset 'cs_comments_service' does not exist," run the following command to create the gemset and then use the rvm environment manually: + + rvm gemset create 'cs_comments_service' + rvm use 1.9.3@cs_comments_service + +Now use the following command to install required packages: + + bundle install + +The following command creates database indexes: + + bundle exec rake db:init + +Now use the following command to generate seeds (basically some random comments in Latin): + + bundle exec rake db:seed + +It's done! Launch the app now: + + ruby app.rb + +## Running the delayed job worker + +In the discussion service, notifications are handled asynchronously using a third party gem called delayed_job. If you want to test this functionality, run the following command in a separate tab: + + bundle exec rake jobs:work + +## Some other useful commands + +### generate seeds for a specific forum +The seed generating command above assumes that you have the following discussion tags somewhere in the course data: + + + + + +For example, you can insert them into overview section as following: + + +
+ + +
+
+ <%include file="sections/introseq.xml"/> +
+
+ + See the Lab Introduction or Interactive Lab Usage Handout for information on how to do the lab + + + +
+
+ + + + +
+ + +Currently, only the attribute "id" is actually used, which is the unique identification of the discussion forum. In the data generator code, the lines for generating seeds are as following: + + generate_comments_for("video_1") + generate_comments_for("lab_1") + generate_comments_for("lab_2") + +We also have a command for generating comments within a forum with the specified id: + + bundle exec rake db:generate_comments[type_the_discussion_id_here] + +For instance, if you want to generate comments for the general discussion, for which the discussion id is the course id with slashes and dots replaced by underscores (you *should* do this before testing forum view) and you are in 6.002x, use the following command + + bundle exec rake db:generate_comments[MITx_6_002x_2012_Fall] + +### Running tests for the service + + bundle exec rspec + +### debugging the service + +You can use the following command to launch a console within the service environment: + + bundle exec rake console