Skip to content

Commit

Permalink
Update README to clarify requirements for tests involving Symplectic …
Browse files Browse the repository at this point in the history
…Elements
  • Loading branch information
jonavellecuerdo committed Mar 7, 2024
1 parent a30eda9 commit 85be58b
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 85be58b

Please sign in to comment.