Skip to content

fix port to be 8000#3081

Open
krista-skylight wants to merge 5 commits intomainfrom
kc/documentation-nit
Open

fix port to be 8000#3081
krista-skylight wants to merge 5 commits intomainfrom
kc/documentation-nit

Conversation

@krista-skylight
Copy link

Description

I spun up this app for my own edification while reviewing Mary's PR and found the port defaulted to 8000, so updating documentation. If we want to use 8001 for a reason, I think we'll need to specify in .env file.

Checklist before requesting a review

  • PR focuses on a single story
  • Code has been fully tested to meet acceptance criteria
  • PR is reasonably small and reviewable (Generally less than 10 files and 500 changed lines)
  • All new functions/classes/components reasonably small
  • Functions/classes/components focused on one responsibility
  • Code easy to understand and modify (clarity over concise/clever)
  • PRs containing TypeScript follow the Do's and Don'ts
  • PR does not contain hardcoded values (Uses constants)
  • All code is covered by unit or feature tests

@krista-skylight krista-skylight requested a review from a team as a code owner March 11, 2026 03:26
@krista-skylight krista-skylight requested review from emyl3 and mcmcgrath13 and removed request for a team March 11, 2026 03:26
@mcmcgrath13
Copy link
Contributor

nice catch! docker runs on 8001 and if you use the sample.env, that will push you to 8001 as well. Is there any way to change the default in the app to 8001? nbs-gateway runs on 8000, so it'd be nice to avoid the clash by default

@mcmcgrath13
Copy link
Contributor

You now need the .env instead of nice-to-have .env due to the DB setup. I left a couple suggestions that make that more clear and then the port will be 8001 instead of 8000

krista-skylight and others added 3 commits March 11, 2026 09:46
Co-authored-by: Mary McGrath <m.c.mcgrath13@gmail.com>
Co-authored-by: Mary McGrath <m.c.mcgrath13@gmail.com>
.pytest_cache/
.venv/ No newline at end of file
.venv/
.env No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(q, nb): .env should already be ignored based on the top level .gitignore - were you seeing otherwise? (checking my knowledge of how gitignores work)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I did this kind of reflexively. You are totally right!

Sample curl:
```sh
curl -X POST 'http://localhost:8001/report/execute' -H "accept: application/json" -H "Content-Type: application/json" -d '{
curl -X POST 'http://localhost:8000/report/execute' -H "accept: application/json" -H "Content-Type: application/json" -d '{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
curl -X POST 'http://localhost:8000/report/execute' -H "accept: application/json" -H "Content-Type: application/json" -d '{
curl -X POST 'http://localhost:8001/report/execute' -H "accept: application/json" -H "Content-Type: application/json" -d '{

Comment on lines +43 to +45
- API: http://localhost:8000
- Interactive API docs (Swagger UI): http://localhost:8000/docs
- Alternative API docs (ReDoc): http://localhost:8000/redoc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- API: http://localhost:8000
- Interactive API docs (Swagger UI): http://localhost:8000/docs
- Alternative API docs (ReDoc): http://localhost:8000/redoc
- API: http://localhost:8001
- Interactive API docs (Swagger UI): http://localhost:8001/docs
- Alternative API docs (ReDoc): http://localhost:8001/redoc

@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants