Skip to content

Commit

Permalink
Merge pull request #765 from RockefellerArchiveCenter/issue-749
Browse files Browse the repository at this point in the history
Adds configuration section to readme
  • Loading branch information
helrond authored Dec 4, 2024
2 parents b4e2224 + e8438e4 commit 6356ba4
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,17 @@ A React web application which provides the front-end user interface for the onli

DIMES is part of [Project Electron](https://github.com/RockefellerArchiveCenter/project_electron), an initiative to build sustainable, open and user-centered infrastructure for the archival management of digital records at the [Rockefeller Archive Center](http://rockarch.org/).

## Configuring DIMES
In order to support a variety of use cases, there are several configuration options in DIMES which can be activated or deactivated as desired.

### Aeon Reading Room Integration

Available dates for reading rooms can be pulled from Aeon via the request broker by setting the `REACT_APP_ENABLE_READING_ROOM_SELECT` environment variable. Not setting this environment variable or leaving it blank will disable this feature. Setting this environment variable to any string will activate it.

### Duplication Request Limits

It is possible to limit the number of duplication requests a user can submit at once by setting the `REACT_APP_DUPLICATION_REQUEST_LIMIT` environment variable. Not setting this environment variable or leaving it blank will disable this feature.

## Local Development

Install [git](https://git-scm.com/) and clone the repository
Expand Down Expand Up @@ -82,14 +93,6 @@ DIMES uses a [macro implementation](https://lingui.dev/guides/message-extraction
to present translated strings.
5. Commit updated code to the GitHub repository.

### Aeon Reading Room Integration

Available dates for reading rooms can be pulled from Aeon via the request broker by setting the `REACT_APP_ENABLE_READING_ROOM_SELECT` environment variable. Not setting this environment variable or leaving it blank will disable this feature. Setting this environment variable to any string will activate it.

### Duplication Request Limits

It is possible to limit the number of duplication requests a user can submit at once by setting the `REACT_APP_DUPLICATION_REQUEST_LIMIT` environment variable. Not setting this environment variable or leaving it blank will disable this feature.

## License

This code is released under an [MIT License](LICENSE).

0 comments on commit 6356ba4

Please sign in to comment.