{"action":"created","comment":{"url":"https://api.github.com/repos/mitodl/micromasters/pulls/comments/57620811","id":57620811,"diff_hunk":"@@ -1,2 +1,104 @@\n # micromasters\n Portal for learners and course teams to access MITx micromasters programs\n+\n+Getting Started\n+---------------\n+\n+You can either run micromasters locally with a default sqlite database after\n+installing the ``requirements.txt`` file, or if you have Docker and\n+prefer a cleaner environment, install ``docker-compose`` with ``pip\n+install docker-compose`` and run ``docker-compose up``. This will set\n+up a near production-ready containerized development environment that\n+runs migrations, with the Django development server running on\n+port ``8079``.\n+\n+To run one-off commands, like shell, you can run::\n+\n+  docker-compose run web python manage.py shell\n+\n+or to create root user::\n+\n+  docker-compose run web python manage.py createsuperuser\n+\n+\n+For OS X Development\n+--------------------\n+\n+Due to issues using Docker in OSX, development is more efficient if you\n+install `docker-osx-dev <https://github.com/brikis98/docker-osx-dev>`_.\n+``docker-osx-dev`` keeps host file system changes synced to the Docker\n+container. You can install it by typing ``make`` once you have created the\n+Docker container.\n+\n+Subsequently, before you start your Docker container with\n+``docker-compose up``, you would run::\n+  \n+     docker-osx-dev -m default -s ./\n+\n+(Assuming your Docker VM is called ``default``, and your current working\n+directory is the root of the ``teachersportal`` source directory).\n+\n+This starts a process that monitors the file system for changes. On startup\n+you may receive this error::\n+  \n+      [ERROR] Found VirtualBox shared folders on your Boot2Docker VM. These may\n+      void any performance benefits from using docker-osx-dev:\n+      \n+      /Users\n+      \n+      [INSTRUCTIONS] Would you like this script to remove them?\n+      1) yes\n+      2) no\n+\n+Answer ``yes``.\n+\n+Configuration and Start-up\n+--------------------------\n+\n+1. Copy the ``.env.sample`` file to ``.env`` and edit these values::\n+    \n+    STATUS_TOKEN=\n+    EDXORG_BASE_URL=\n+    EDXORG_CLIENT_ID=\n+    EDXORG_CLIENT_SECRET=\n+\n+#. (OSX only) Create your docker machine::\n+\n+     docker-machine create default\n+     docker-machine start default\n+     docker-machine env default\n+     eval \"$(docker-machine env default)\"\n+\n+   These commands create a Docker container named ``default``, start the\n+   container, and configure environment variables to facilitate communication\n+   with ``ccxcon``.\n+\n+#. Create a user who has permission to view the course::\n+\n+     docker-compose run web python manage.py createsuperuser\n+\n+#. Start the machine::\n+\n+     docker-compose up\n+\n+#. visit: http://192.168.99.100:8075/\n+\n+.. note:: (OSX only)\n+\n+  Your IP address may vary depending on what address docker assigns to your VM.\n+  If the IP above doesn't work:\n+\n+  1. Power down your docker-machine (``docker-machine stop default``)\n+  2. ``docker-machine ssh default``\n+  3. Once in the docker machine shell, run ``ifconfig``, and look for\n+     the IP address that begins with ``192.168.99.xxx``.\n+\n+- Click the login button on the TP UI and put in the user credentials","path":"README.md","position":96,"original_position":96,"commit_id":"b064a3d4143b2ed9e84e4cb2794c10241a2fd6c0","original_commit_id":"b064a3d4143b2ed9e84e4cb2794c10241a2fd6c0","user":{"login":"noisecapella","id":863262,"avatar_url":"https://avatars.githubusercontent.com/u/863262?v=3","gravatar_id":"","url":"https://api.github.com/users/noisecapella","html_url":"https://github.com/noisecapella","followers_url":"https://api.github.com/users/noisecapella/followers","following_url":"https://api.github.com/users/noisecapella/following{/other_user}","gists_url":"https://api.github.com/users/noisecapella/gists{/gist_id}","starred_url":"https://api.github.com/users/noisecapella/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/noisecapella/subscriptions","organizations_url":"https://api.github.com/users/noisecapella/orgs","repos_url":"https://api.github.com/users/noisecapella/repos","events_url":"https://api.github.com/users/noisecapella/events{/privacy}","received_events_url":"https://api.github.com/users/noisecapella/received_events","type":"User","site_admin":false},"body":"Can you remove the lines here and below? It looks like it only applies to teachersportal","created_at":"2016-03-28T19:38:23Z","updated_at":"2016-03-28T19:38:23Z","html_url":"https://github.com/mitodl/micromasters/pull/119#discussion_r57620811","pull_request_url":"https://api.github.com/repos/mitodl/micromasters/pulls/119","_links":{"self":{"href":"https://api.github.com/repos/mitodl/micromasters/pulls/comments/57620811"},"html":{"href":"https://github.com/mitodl/micromasters/pull/119#discussion_r57620811"},"pull_request":{"href":"https://api.github.com/repos/mitodl/micromasters/pulls/119"}}},"pull_request":{"url":"https://api.github.com/repos/mitodl/micromasters/pulls/119","id":64361503,"html_url":"https://github.com/mitodl/micromasters/pull/119","diff_url":"https://github.com/mitodl/micromasters/pull/119.diff","patch_url":"https://github.com/mitodl/micromasters/pull/119.patch","issue_url":"https://api.github.com/repos/mitodl/micromasters/issues/119","number":119,"state":"open","locked":false,"title":"Added setup documentation","user":{"login":"pwilkins","id":145821,"avatar_url":"https://avatars.githubusercontent.com/u/145821?v=3","gravatar_id":"","url":"https://api.github.com/users/pwilkins","html_url":"https://github.com/pwilkins","followers_url":"https://api.github.com/users/pwilkins/followers","following_url":"https://api.github.com/users/pwilkins/following{/other_user}","gists_url":"https://api.github.com/users/pwilkins/gists{/gist_id}","starred_url":"https://api.github.com/users/pwilkins/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pwilkins/subscriptions","organizations_url":"https://api.github.com/users/pwilkins/orgs","repos_url":"https://api.github.com/users/pwilkins/repos","events_url":"https://api.github.com/users/pwilkins/events{/privacy}","received_events_url":"https://api.github.com/users/pwilkins/received_events","type":"User","site_admin":false},"body":"#### What are the relevant tickets?\r\nNone.\r\n\r\n#### What's this PR do?\r\nProvide guidance for developers trying run Micromasters.\r\n\r\n#### Where should the reviewer start?\r\nOpen the \"Getting Started\" section in ``README.md`` and follow the instructions.\r\n\r\n#### How should this be manually tested?\r\nFollow the instructions and see if it works.\r\n\r\n#### Any background context you want to provide?\r\nThe setup procedure is more complex for OSX than for Linux.\r\n\r\n#### What GIF best describes this PR or how it makes you feel?\r\n![](http://i.giphy.com/DerFO35Hmojfi.gif)\r\n\r\n\r\nAdded setup documentation to ``README.md``.","created_at":"2016-03-28T19:17:42Z","updated_at":"2016-03-28T19:38:23Z","closed_at":null,"merged_at":null,"merge_commit_sha":"c5d58ec8efaffbfd12c79ed38104ccda307591e4","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/mitodl/micromasters/pulls/119/commits","review_comments_url":"https://api.github.com/repos/mitodl/micromasters/pulls/119/comments","review_comment_url":"https://api.github.com/repos/mitodl/micromasters/pulls/comments{/number}","comments_url":"https://api.github.com/repos/mitodl/micromasters/issues/119/comments","statuses_url":"https://api.github.com/repos/mitodl/micromasters/statuses/b064a3d4143b2ed9e84e4cb2794c10241a2fd6c0","head":{"label":"mitodl:feature/pw/setup-doc","ref":"feature/pw/setup-doc","sha":"b064a3d4143b2ed9e84e4cb2794c10241a2fd6c0","user":{"login":"mitodl","id":7918516,"avatar_url":"https://avatars.githubusercontent.com/u/7918516?v=3","gravatar_id":"","url":"https://api.github.com/users/mitodl","html_url":"https://github.com/mitodl","followers_url":"https://api.github.com/users/mitodl/followers","following_url":"https://api.github.com/users/mitodl/following{/other_user}","gists_url":"https://api.github.com/users/mitodl/gists{/gist_id}","starred_url":"https://api.github.com/users/mitodl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mitodl/subscriptions","organizations_url":"https://api.github.com/users/mitodl/orgs","repos_url":"https://api.github.com/users/mitodl/repos","events_url":"https://api.github.com/users/mitodl/events{/privacy}","received_events_url":"https://api.github.com/users/mitodl/received_events","type":"Organization","site_admin":false},"repo":{"id":52919185,"name":"micromasters","full_name":"mitodl/micromasters","owner":{"login":"mitodl","id":7918516,"avatar_url":"https://avatars.githubusercontent.com/u/7918516?v=3","gravatar_id":"","url":"https://api.github.com/users/mitodl","html_url":"https://github.com/mitodl","followers_url":"https://api.github.com/users/mitodl/followers","following_url":"https://api.github.com/users/mitodl/following{/other_user}","gists_url":"https://api.github.com/users/mitodl/gists{/gist_id}","starred_url":"https://api.github.com/users/mitodl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mitodl/subscriptions","organizations_url":"https://api.github.com/users/mitodl/orgs","repos_url":"https://api.github.com/users/mitodl/repos","events_url":"https://api.github.com/users/mitodl/events{/privacy}","received_events_url":"https://api.github.com/users/mitodl/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/mitodl/micromasters","description":"Portal for learners and course teams to access MITx micromasters programs: https://goo.gl/tsUTSO","fork":false,"url":"https://api.github.com/repos/mitodl/micromasters","forks_url":"https://api.github.com/repos/mitodl/micromasters/forks","keys_url":"https://api.github.com/repos/mitodl/micromasters/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mitodl/micromasters/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mitodl/micromasters/teams","hooks_url":"https://api.github.com/repos/mitodl/micromasters/hooks","issue_events_url":"https://api.github.com/repos/mitodl/micromasters/issues/events{/number}","events_url":"https://api.github.com/repos/mitodl/micromasters/events","assignees_url":"https://api.github.com/repos/mitodl/micromasters/assignees{/user}","branches_url":"https://api.github.com/repos/mitodl/micromasters/branches{/branch}","tags_url":"https://api.github.com/repos/mitodl/micromasters/tags","blobs_url":"https://api.github.com/repos/mitodl/micromasters/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mitodl/micromasters/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mitodl/micromasters/git/refs{/sha}","trees_url":"https://api.github.com/repos/mitodl/micromasters/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mitodl/micromasters/statuses/{sha}","languages_url":"https://api.github.com/repos/mitodl/micromasters/languages","stargazers_url":"https://api.github.com/repos/mitodl/micromasters/stargazers","contributors_url":"https://api.github.com/repos/mitodl/micromasters/contributors","subscribers_url":"https://api.github.com/repos/mitodl/micromasters/subscribers","subscription_url":"https://api.github.com/repos/mitodl/micromasters/subscription","commits_url":"https://api.github.com/repos/mitodl/micromasters/commits{/sha}","git_commits_url":"https://api.github.com/repos/mitodl/micromasters/git/commits{/sha}","comments_url":"https://api.github.com/repos/mitodl/micromasters/comments{/number}","issue_comment_url":"https://api.github.com/repos/mitodl/micromasters/issues/comments{/number}","contents_url":"https://api.github.com/repos/mitodl/micromasters/contents/{+path}","compare_url":"https://api.github.com/repos/mitodl/micromasters/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mitodl/micromasters/merges","archive_url":"https://api.github.com/repos/mitodl/micromasters/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mitodl/micromasters/downloads","issues_url":"https://api.github.com/repos/mitodl/micromasters/issues{/number}","pulls_url":"https://api.github.com/repos/mitodl/micromasters/pulls{/number}","milestones_url":"https://api.github.com/repos/mitodl/micromasters/milestones{/number}","notifications_url":"https://api.github.com/repos/mitodl/micromasters/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mitodl/micromasters/labels{/name}","releases_url":"https://api.github.com/repos/mitodl/micromasters/releases{/id}","deployments_url":"https://api.github.com/repos/mitodl/micromasters/deployments","created_at":"2016-03-01T23:53:17Z","updated_at":"2016-03-25T01:03:13Z","pushed_at":"2016-03-28T19:17:42Z","git_url":"git://github.com/mitodl/micromasters.git","ssh_url":"git@github.com:mitodl/micromasters.git","clone_url":"https://github.com/mitodl/micromasters.git","svn_url":"https://github.com/mitodl/micromasters","homepage":"","size":92,"stargazers_count":1,"watchers_count":1,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":43,"forks":0,"open_issues":43,"watchers":1,"default_branch":"master"}},"base":{"label":"mitodl:master","ref":"master","sha":"105a65e3bacac08c7de9acc487ff2ba9cc69faea","user":{"login":"mitodl","id":7918516,"avatar_url":"https://avatars.githubusercontent.com/u/7918516?v=3","gravatar_id":"","url":"https://api.github.com/users/mitodl","html_url":"https://github.com/mitodl","followers_url":"https://api.github.com/users/mitodl/followers","following_url":"https://api.github.com/users/mitodl/following{/other_user}","gists_url":"https://api.github.com/users/mitodl/gists{/gist_id}","starred_url":"https://api.github.com/users/mitodl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mitodl/subscriptions","organizations_url":"https://api.github.com/users/mitodl/orgs","repos_url":"https://api.github.com/users/mitodl/repos","events_url":"https://api.github.com/users/mitodl/events{/privacy}","received_events_url":"https://api.github.com/users/mitodl/received_events","type":"Organization","site_admin":false},"repo":{"id":52919185,"name":"micromasters","full_name":"mitodl/micromasters","owner":{"login":"mitodl","id":7918516,"avatar_url":"https://avatars.githubusercontent.com/u/7918516?v=3","gravatar_id":"","url":"https://api.github.com/users/mitodl","html_url":"https://github.com/mitodl","followers_url":"https://api.github.com/users/mitodl/followers","following_url":"https://api.github.com/users/mitodl/following{/other_user}","gists_url":"https://api.github.com/users/mitodl/gists{/gist_id}","starred_url":"https://api.github.com/users/mitodl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mitodl/subscriptions","organizations_url":"https://api.github.com/users/mitodl/orgs","repos_url":"https://api.github.com/users/mitodl/repos","events_url":"https://api.github.com/users/mitodl/events{/privacy}","received_events_url":"https://api.github.com/users/mitodl/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/mitodl/micromasters","description":"Portal for learners and course teams to access MITx micromasters programs: https://goo.gl/tsUTSO","fork":false,"url":"https://api.github.com/repos/mitodl/micromasters","forks_url":"https://api.github.com/repos/mitodl/micromasters/forks","keys_url":"https://api.github.com/repos/mitodl/micromasters/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mitodl/micromasters/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mitodl/micromasters/teams","hooks_url":"https://api.github.com/repos/mitodl/micromasters/hooks","issue_events_url":"https://api.github.com/repos/mitodl/micromasters/issues/events{/number}","events_url":"https://api.github.com/repos/mitodl/micromasters/events","assignees_url":"https://api.github.com/repos/mitodl/micromasters/assignees{/user}","branches_url":"https://api.github.com/repos/mitodl/micromasters/branches{/branch}","tags_url":"https://api.github.com/repos/mitodl/micromasters/tags","blobs_url":"https://api.github.com/repos/mitodl/micromasters/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mitodl/micromasters/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mitodl/micromasters/git/refs{/sha}","trees_url":"https://api.github.com/repos/mitodl/micromasters/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mitodl/micromasters/statuses/{sha}","languages_url":"https://api.github.com/repos/mitodl/micromasters/languages","stargazers_url":"https://api.github.com/repos/mitodl/micromasters/stargazers","contributors_url":"https://api.github.com/repos/mitodl/micromasters/contributors","subscribers_url":"https://api.github.com/repos/mitodl/micromasters/subscribers","subscription_url":"https://api.github.com/repos/mitodl/micromasters/subscription","commits_url":"https://api.github.com/repos/mitodl/micromasters/commits{/sha}","git_commits_url":"https://api.github.com/repos/mitodl/micromasters/git/commits{/sha}","comments_url":"https://api.github.com/repos/mitodl/micromasters/comments{/number}","issue_comment_url":"https://api.github.com/repos/mitodl/micromasters/issues/comments{/number}","contents_url":"https://api.github.com/repos/mitodl/micromasters/contents/{+path}","compare_url":"https://api.github.com/repos/mitodl/micromasters/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mitodl/micromasters/merges","archive_url":"https://api.github.com/repos/mitodl/micromasters/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mitodl/micromasters/downloads","issues_url":"https://api.github.com/repos/mitodl/micromasters/issues{/number}","pulls_url":"https://api.github.com/repos/mitodl/micromasters/pulls{/number}","milestones_url":"https://api.github.com/repos/mitodl/micromasters/milestones{/number}","notifications_url":"https://api.github.com/repos/mitodl/micromasters/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mitodl/micromasters/labels{/name}","releases_url":"https://api.github.com/repos/mitodl/micromasters/releases{/id}","deployments_url":"https://api.github.com/repos/mitodl/micromasters/deployments","created_at":"2016-03-01T23:53:17Z","updated_at":"2016-03-25T01:03:13Z","pushed_at":"2016-03-28T19:17:42Z","git_url":"git://github.com/mitodl/micromasters.git","ssh_url":"git@github.com:mitodl/micromasters.git","clone_url":"https://github.com/mitodl/micromasters.git","svn_url":"https://github.com/mitodl/micromasters","homepage":"","size":92,"stargazers_count":1,"watchers_count":1,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":43,"forks":0,"open_issues":43,"watchers":1,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/mitodl/micromasters/pulls/119"},"html":{"href":"https://github.com/mitodl/micromasters/pull/119"},"issue":{"href":"https://api.github.com/repos/mitodl/micromasters/issues/119"},"comments":{"href":"https://api.github.com/repos/mitodl/micromasters/issues/119/comments"},"review_comments":{"href":"https://api.github.com/repos/mitodl/micromasters/pulls/119/comments"},"review_comment":{"href":"https://api.github.com/repos/mitodl/micromasters/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/mitodl/micromasters/pulls/119/commits"},"statuses":{"href":"https://api.github.com/repos/mitodl/micromasters/statuses/b064a3d4143b2ed9e84e4cb2794c10241a2fd6c0"}}}}