-
Notifications
You must be signed in to change notification settings - Fork 7
fix port to be 8000 #3081
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
krista-skylight
wants to merge
5
commits into
main
Choose a base branch
from
kc/documentation-nit
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
fix port to be 8000 #3081
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f2dd7cb
docs: fix port to be 8000
f40bbab
Update apps/report-execution/README.md
krista-skylight 4a1f036
Update apps/report-execution/README.md
krista-skylight cfab915
docs: Add .env to .gitignore
99f6ce4
chore: remove .env from .gitignore
krista-skylight File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| __pycache__/ | ||
| .ruff_cache/ | ||
| .pytest_cache/ | ||
| .venv/ | ||
| .venv/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -16,7 +16,7 @@ | |||||
| uv sync --frozen | ||||||
| ``` | ||||||
|
|
||||||
| 1. (Optional) Create a `.env` file from the `sample.env`, if you'd like to configure the application's port or host during local development (particularly helpful if you're running outside of Docker). _NOTE: You'll need to manually load the env (`export $(xargs <.env)`), add `--env-file .env` to `uv` commands, or install and configure [direnv](https://direnv.net/) (or an equivalent shell extension) in order to make these environment variables available to the application._ | ||||||
| 1. Create a `.env` file from the `sample.env`, if you'd like to configure the application's port or host during local development (particularly helpful if you're running outside of Docker). _NOTE: You'll need to manually load the env (`export $(xargs <.env)`), add `--env-file .env` to `uv` commands, or install and configure [direnv](https://direnv.net/) (or an equivalent shell extension) in order to make these environment variables available to the application._ | ||||||
|
|
||||||
| ```sh | ||||||
| cp sample.env .env | ||||||
|
|
@@ -36,17 +36,17 @@ | |||||
| 1. Start the FastAPI development server with [Uvicorn](https://uvicorn.dev/) (the default ASGI server program shipped with FastAPI): | ||||||
|
|
||||||
| ```bash | ||||||
| uv run uvicorn src.main:app | ||||||
| uv run --env-file .env uvicorn src.main:app | ||||||
| ``` | ||||||
|
|
||||||
| The application will be available at: | ||||||
| - API: http://localhost:8001 | ||||||
| - Interactive API docs (Swagger UI): http://localhost:8001/docs | ||||||
| - Alternative API docs (ReDoc): http://localhost:8001/redoc | ||||||
| - API: http://localhost:8000 | ||||||
| - Interactive API docs (Swagger UI): http://localhost:8000/docs | ||||||
| - Alternative API docs (ReDoc): http://localhost:8000/redoc | ||||||
|
|
||||||
| 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 '{ | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| "version": 1, | ||||||
| "is_export": true, | ||||||
| "is_builtin": true, | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.