Finialize Readme File and Instructions#136
Merged
ArcueidShiki merged 2 commits intomainfrom May 16, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR finalizes documentation updates and adjusts some backend/frontend functionality, including minor code tweaks.
- Added a console log for user clicks and updated localStorage key usage for chat lists in the frontend.
- Updated image class names and directory structure for summary image generation in the backend and fixed image paths in documentation.
- Refined README with test user credentials and application screenshots.
Reviewed Changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| frontend/js/chat.js | Added debug logging and changed localStorage key; review key mismatch. |
| docs/StartFrontend.md | Added test credentials and instructions for running the frontend. |
| docs/StartBackend.md | Updated image path reference for backend documentation. |
| backend/app/utils/img.py | Updated logic for displaying profit/loss text in summary images. |
| backend/app/controllers/chat_controller.py | Revised directory and file naming for summary image storage. |
| backend/app/app.dump.sql | Added new SQL insert entries to support summary images. |
| README.md | Extended documentation with test accounts and application screenshots. |
Comments suppressed due to low confidence (1)
backend/app/utils/img.py:10
- Revisit the condition change for zero profit values. Confirm if displaying '+0%' as profit is intended, as this modifies the previous logic.
profit_text = f"Profit +{profit_value}%" if profit_value >= 0 else f"Loss {profit_value}%"
| </div> | ||
| `); | ||
| resultItem.on("click", () => { | ||
| console.log("User clicked:", user); |
There was a problem hiding this comment.
[nitpick] Consider removing the debug log statement or gating it under a debug flag before merging to production.
Suggested change
| console.log("User clicked:", user); | |
| if (DEBUG) { | |
| console.log("User clicked:", user); | |
| } |
|
|
||
| function getChatList() { | ||
| chatList = JSON.parse(localStorage.getItem("chatList")) || []; | ||
| chatList = JSON.parse(localStorage.getItem("userList")) || []; |
There was a problem hiding this comment.
There is an inconsistency in localStorage key usage: the value is read from "userList" but later written as "chatList". Please update the key to be consistent.
Suggested change
| chatList = JSON.parse(localStorage.getItem("userList")) || []; | |
| chatList = JSON.parse(localStorage.getItem("chatList")) || []; |
Signed-off-by: ArcueidShiki <52120441+ArcueidShiki@users.noreply.github.com>
ArcueidShiki
added a commit
that referenced
this pull request
Mar 15, 2026
Finialize Readme File and Instructions Signed-off-by: Arcueid <52120441+ArcueidShiki@users.noreply.github.com>
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
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.
Description
Please include a summary of the change and which issue is fixed.
Type of change
Checklist