Skip to content

Commit

Permalink
Merge pull request #179 from nulib/update-readme
Browse files Browse the repository at this point in the history
Update URLs in Readme to be current
  • Loading branch information
adamjarling authored Dec 12, 2023
2 parents 337af8c + 896a2bd commit c09a14d
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ sam local start-api --host 0.0.0.0 --log-file dc-api.log
The API will be available at:

- `http://localhost:3000` (from your dev environment)
- `http://USER_PREFIX.dev.library.northwestern.edu:3000` (from elsewhere)
- `http://USER_PREFIX.dev.rdc.library.northwestern.edu:3000` (from elsewhere)
- Don't forget to [open port 3000](https://github.com/nulib/aws-developer-environment#convenience-scripts) if you want to access it remotely

⚠️ Note the above URLs (which point to your local OpenSearch instance) need _full endpoints_ to resolve. For example:

- `http://USER_PREFIX.dev.library.northwestern.edu:3000/search`
- `http://USER_PREFIX.dev.library.northwestern.edu:3000/collections`
- `http://USER_PREFIX.dev.rdc.library.northwestern.edu:3000/search`
- `http://USER_PREFIX.dev.rdc.library.northwestern.edu:3000/collections`

[View supported endpoints](https://api.dc.library.northwestern.edu/docs/v2/spec/openapi.html) Questions? [View the production API documention](https://api.dc.library.northwestern.edu/)

Expand All @@ -84,8 +84,8 @@ View and edit information about a specific Work in the Index.

1. Open a local Meadow instance.
2. Find an `id` of a Work you'd like to inspect in the API.
3. View JSON response at `http://USER_PREFIX.dev.library.northwestern.edu:3000/works/[WORK_ID]`
4. View IIIF Manifest JSON response at `http://USER_PREFIX.dev.library.northwestern.edu:3000/works/[WORK_ID]?as=iiif`
3. View JSON response at `http://USER_PREFIX.dev.rdc.library.northwestern.edu:3000/works/[WORK_ID]`
4. View IIIF Manifest JSON response at `http://USER_PREFIX.dev.rdc.library.northwestern.edu:3000/works/[WORK_ID]?as=iiif`

For help debugging/inspecting, JavaScript `console` messages are written to: `dc-api-v2/dc-api.log`

Expand Down Expand Up @@ -141,8 +141,6 @@ bin/start-with-step
aws stepfunctions create-state-machine --endpoint http://localhost:8083 --definition file://state_machines/av_download.json --name "hlsStitcherStepFunction" --role-arn arn:aws:iam::012345678901:role/DummyRole
```



## Deploying the API manually

- Symlink the `*.parameters` file you need from `tfvars/dc-api/` to the application root
Expand Down

0 comments on commit c09a14d

Please sign in to comment.