Part of edX code.
An independent comment system which supports voting and nested comments. It also supports features including instructor endorsement for education-aimed discussion platforms.
If you are running cs_comments_service as part of edx-platform development under devstack, it is strongly recommended to read those setup documents first. Note that devstack will take care of just about all of the installation, configuration, and service management on your behalf. If running outside of devstack, continue reading below.
This service relies on Elasticsearch and MongoDB. By default the service will use the Elasticsearch server available at http://localhost:9200 and the MongoDB server available at localhost:27017. This is suitable for local development; however, if you wish to change these values, refer to config/application.yml and config/mongoid.yml for the environment variables that can be set to override the defaults.
Before the server is first run, ensure gems are installed by doing bundle install.
To run the server, do ruby app.rb [-p PORT] where PORT defaults to 4567.
To run tests, do bundle exec rspec. Append --help or see rspec documentation for additional options to this command.
To run the comments service in a language other than English, set the SERVICE_LANGUAGE environment variable to the language code for the desired language. Its default value is en-US.
Setting the language has no effect on user content stored by the service. However, there are a few data validation messages that may be seen by end users via the frontend in edx-platform. These will be translated to SERVICE_LANGUAGE assuming a suitable translation file is found in the locale/ directory.
edX uses Transifex to host translations. To use the Transifex client, be sure it is installed (pip install transifex-client will do this for you), and follow the instructions here to set up your .transifexrc file.
To upload strings to Transifex for translation when you change the set of translatable strings: bundle exec rake i18n:push
To fetch the latest translations from Transifex: bundle exec rake i18n:pull
The repository includes some translations so they will be available upon deployment. To commit an update to these: bundle exec rake i18n:commit
The code in this repository is licensed under version 3 of the AGPL unless otherwise noted.
Please see LICENSE.txt for details.
Contributions are very welcome. The easiest way is to fork this repo, and then make a pull request from your fork. The first time you make a pull request, you may be asked to sign a Contributor Agreement.
Please do not report security issues in public. Please email security@edx.org
You can discuss this code on the edx-code Google Group or in the edx-code IRC channel on Freenode.