feat: Add python readme#34
Merged
shuangela merged 2 commits intodevelopmentfrom Nov 7, 2025
Merged
Conversation
dacharyc
requested changes
Nov 7, 2025
Collaborator
dacharyc
left a comment
dacharyc
left a comment
There was a problem hiding this comment.
Few small changes related to how the copier tool will rename directories and files when they get copied out to the artifact repo, but overall, LGTM!
| ├── README.md | ||
| ├── client/ # Next.js frontend | ||
| └── server/ # Python FastAPI backend | ||
| ├── README-PYTHON-FASTAPI.md |
Collaborator
There was a problem hiding this comment.
As this is meant to represent the public-facing project, the README will be renamed by the copy tool to just README.md in the artifact repo.
Suggested change
| ├── README-PYTHON-FASTAPI.md | |
| ├── README.md |
| └── server/ # Python FastAPI backend | ||
| ├── README-PYTHON-FASTAPI.md | ||
| ├── client/ # Next.js frontend (TypeScript) | ||
| └── server/python-fastapi/ # Python FastAPI backend |
Collaborator
There was a problem hiding this comment.
Similar to above, the copier tool will rename this to just server in the artifact repo.
Suggested change
| └── server/python-fastapi/ # Python FastAPI backend | |
| └── server/ # Python FastAPI backend |
| Navigate to the Python FastAPI server directory: | ||
|
|
||
| ```bash | ||
| cd server/python-fastapi |
Collaborator
There was a problem hiding this comment.
Suggested change
| cd server/python-fastapi | |
| cd server/ |
|
|
||
| ### 2. Start the Backend Server | ||
|
|
||
| From the `server/python-fastapi` directory, run: |
Collaborator
There was a problem hiding this comment.
Suggested change
| From the `server/python-fastapi` directory, run: | |
| From the `server/` directory, run: |
| To run all tests: | ||
|
|
||
| ```bash | ||
| cd server/python-fastapi |
Collaborator
There was a problem hiding this comment.
Suggested change
| cd server/python-fastapi | |
| cd server/ |
This was referenced Apr 2, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds updated Python readme and removes old readme, Python readme is based off Java readme