From 85be58b46c1f15a535e20ac8484aa75e06b8faf8 Mon Sep 17 00:00:00 2001 From: jonavellecuerdo <cuerdojonavelle@gmail.com> Date: Thu, 7 Mar 2024 15:17:52 -0500 Subject: [PATCH] Update README to clarify requirements for tests involving Symplectic Elements --- README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5ca210a..7d8e364 100644 --- a/README.md +++ b/README.md @@ -17,21 +17,18 @@ Solenoid is a web application for sending email requests for publications to stu * To lint the repo: `make lint` * To run the app: `pipenv run solenoid` -For local development and testing, the following environment variables are recommended to run the full Solenoid workflow: +For local development and testing, the following environment variables are recommended: ``` DJANGO_SECRET_KEY=<random-key> DJANGO_DEBUG=True DJANGO_LOGIN_REQUIRED=True # if testing login - SOLENOID_ADMIN=<developer-email> - DJANGO_EMAIL_TESTING_MODE=True - DJANGO_USE_ELEMENTS=True - DJANGO_ELEMENTS_USER=<valid-elements-api-username> - DJANGO_ELEMENTS_PASSWORD=<valid-elements-api-password> ``` The following sections provide a high-level overview for accessing Solenoid on a local machine and on Heroku. For more detailed walkthroughs and examples, please refer to our [internal documentation on Confluence (WIP)](https://mitlibraries.atlassian.net/l/cp/1hkcgkfG). +**Note:** Any tests that require a connection to Symplectic Elements must be performed through the `staging` app on Heroku. This can be done by manually deploying the `mitlibraries-solenoid-staging` app with the branch pointed to the Github branch under development. + ### Running Solenoid on a local machine 1. Create a `.env` file at the root directory of the Solenoid repo, and set the environment variables recommended for local development and testing.