From a46ec5e550f1287314fb45780a76bdd4efca699d Mon Sep 17 00:00:00 2001
From: Varsha Menon <varshamenon04@gmail.com>
Date: Tue, 19 Nov 2024 10:23:12 -0500
Subject: [PATCH] docs: add local setup to readme

---
 CHANGELOG.rst |  1 +
 README.rst    | 25 ++++++++++++++++++++++++-
 2 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index cdcef76..cf031d8 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -13,6 +13,7 @@ Change Log
 
 Unreleased
 **********
+* Add local setup to readme
 
 4.4.7 - 2024-11-25
 ******************
diff --git a/README.rst b/README.rst
index 69643e4..aafc186 100644
--- a/README.rst
+++ b/README.rst
@@ -26,7 +26,7 @@ One Time Setup
 --------------
 .. code-block::
 
-  # Clone the repository
+  # Clone the repository (in the ../src relative to devstack repo)
   git clone git@github.com:openedx/learning-assistant.git
   cd learning-assistant
 
@@ -34,6 +34,29 @@ One Time Setup
   # Here's how you might do that if you have virtualenvwrapper setup.
   mkvirtualenv -p python3.8 learning-assistant
 
+In your ``requirements/edx/private.txt`` requirements file in edx-platform, add:
+
+.. code-block::
+
+  -e /edx/src/learning-assistant
+
+In your ``lms/envs/private.py`` settings file in edx-platform (create file if necessary), add the below settings. The value of the API key shouldn't matter, because it's not being used at this point, but the setting needs to be there.
+
+.. code-block::
+
+  CHAT_COMPLETION_API = '' # copy url from edx-internal
+  CHAT_COMPLETION_API_KEY = '' # add value though value itself does not matter
+
+  LEARNING_ASSISTANT_PROMPT_TEMPLATE = '' # copy value from edx-internal
+
+  LEARNING_ASSISTANT_AVAILABLE = True
+
+In devstack, run ``make lms-shell`` and run the following command: ``paver install_prereqs;exit``. This will install anything included in your ``private.txt`` requirements file.
+
+In django admin, add the following waffle flag ``learning_assistant.enable_course_content`` and make sure it is turned on for Everyone. The flag should be checked on for: Superusers, Staff, and Authenticated.
+
+This plugin depends on the lms and discovery - both should be running.
+
 Every time you develop something in this repo
 ---------------------------------------------
 .. code-block::