-
-
Notifications
You must be signed in to change notification settings - Fork 289
fix(docs): add FastHTTP Postgres sample run and test instructions - #766
fix(docs): add FastHTTP Postgres sample run and test instructions #766Srinu346 wants to merge 17 commits into
Conversation
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
Srinu346
commented
Jan 27, 2026
@Achanandhi-M sir, please take a look whenever possible.
Thank you !!!!
@Achanandhi-M
Achanandhi-M
left a comment
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.
Hey @Srinu346, please take a look at the other quickstarts to understand how they’re structured. What you’ve added currently feels more like a README, whereas the docs follow a different format. Take your time to review how we’ve added other quickstarts and align this with our existing guides.
Also, please include a video demonstrating your changes and add relevant images as well. Make sure the images have a white background.
Srinu346
commented
Jan 28, 2026
@Achanandhi-M sir i will refine it and update it.
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
Srinu346
commented
Jan 29, 2026
Screen.Recording.2026年01月30日.001941.mp4
@Achanandhi-M sir, please take a look when possible.
Srinu346
commented
Jan 29, 2026
Hi Sir,
Currently, I’m using the previously uploaded images as-is, since they are already hosted in the AWS S3 bucket.
For reference, these are the images being used:
- Record Command:
https://github.com/user-attachments/assets/0db78bd0-571b-4edb-b4f1-30b85d1b2532 - Replay Command:
https://github.com/user-attachments/assets/7e2db585-ff6b-436f-9636-41a8e53575ee
Please let me know if this is okay, or if you would prefer me to update/replace them with new screenshots.
Thank you!
@Achanandhi-M
Achanandhi-M
left a comment
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.
Hey @Srinu346, please avoid removing the existing image from the file—don’t change anything there and use it as is. You can include additional images in the directory if needed; that’s not an issue.
Also, please include a short video showcasing your changes. One more request: kindly avoid using AI-generated text, as it appears that may have been used, and please remove emojis as well. Thanks for understanding.
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
.../docs into fix/quickstart-settings
@Achanandhi-M sir,
Regarding emojis, I have removed most of the unnecessary ones and retained only those that are already used in other quickstart samples for consistency.
I have also revised the content to remove any AI-generated text and updated it accordingly.
Please let me know if any further changes are required.
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
Srinu346
commented
Feb 2, 2026
@Achanandhi-M sir here is a short video of demonstration:
Screen.Recording.2026年02月02日.230840.mp4
Srinu346
commented
Feb 2, 2026
@Achanandhi-M Sir, i have only left out the emojis which were also being used in other setups
@Achanandhi-M
Achanandhi-M
left a comment
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.
The changes look good, @Srinu346 . However, please don’t modify anything in the existing setup—only include the required updates. I noticed that some changes were made to the Docker Compose method; kindly avoid that. Also, I don’t see the images for the Keploy test that were mentioned in the previous review—please add those as well.
Srinu346
commented
Feb 3, 2026
I have added the previously removed part back into the Docker Compose section. I’ve also included the above Keploy test image at the appropriate places both in the Docker Compose section and the WSL/Linux section. I haven’t removed or modified any of the existing images; only added the new ones where relevant.
I’ve tried to limit the changes strictly to the sections where updates were required.
Please let me know if any further changes are needed.
image
Srinu346
commented
Feb 3, 2026
@Achanandhi-M sir, here is a short video of demonstration.
Please have a look.
Recording.2026年02月03日.183820.mp4
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.
Hey @Srinu346, please follow my previous review. I had mentioned not to make any changes to the existing setup, but I still see a few changes there. If there was a specific reason for modifying the existing setup, could you please explain what led to those changes? I’ve attached screenshots for your reference.
Also, for the Linux setup, please follow the approach used in the other Linux setups so we can improve it in a similar way. Additionally, please update the image for the Docker Compose setup—the current image shows the Linux setup. As mentioned in the previous feedback, please add a separate image specifically for the Docker Compose setup. Thanks for your understanding.
ImageCurrent Setup in the Keploy docs:
ImageYour changes:
Image
Achanandhi-M
commented
Feb 4, 2026
Hey @Srinu346, the approach is quite simple. We only want to include the Docker setup, so please add documentation specifically for the Docker setup. If you have any doubts, you can refer to the existing docs.
Also, please include images for the Keploy record and replay steps. Don’t worry about the S3 part—I’ll handle the upload from my side once you’ve created the images.
Lastly, please don’t change any existing steps in the Linux setup. That should be all.
Srinu346
commented
Feb 4, 2026
Thank you sir this cleared a lot things sir.
Srinu346
commented
Feb 4, 2026
@Achanandhi-M sir, here is a short video.
Screen.Recording.2026年02月04日.180044.mp4
I’ve reverted all Linux/WSL changes and updated only the Docker setup documentation along with the Keploy record and replay images.
For consistency with other quickstarts, I took reference from the Echo + SQL sample to follow the same structure and flow.
Thank You.
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
keploy#781) Signed-off-by: Kamakshi Mudgal <navyash110@gmail.com>
7aed6ff to
de87140
Compare
Srinu346
commented
Feb 11, 2026
@Achanandhi-M sir, sir i have corrected the linting error.
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
.../docs into fix/quickstart-settings
Srinu346
commented
Feb 12, 2026
@Achanandhi-M Sir,
I’ve included the environment variables here since they’re required for the application to run properly. Other than that, I haven’t modified any existing steps or structure.
Please let me know if any adjustments are needed.
Screen.Recording.2026年02月12日.193016.mp4
Thank You Very Much Sir.
@amaan-bhati
amaan-bhati
left a comment
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.
Thank you for completing the FastHTTP + Postgres documentation! Adding the Docker Compose workflow alongside the local Linux/WSL path gives users a clear choice based on their setup, and the record/test command examples with the --build-delay and --delay flag explanations are exactly the kind of detail that helps new users avoid common pitfalls.
Issues to be Considered:
-
This PR has been open since February and the
mainbranch has had significant changes since then. Please rebase onto the latestmainand resolve any merge conflicts before requesting another review - stale PRs accumulate drift that can make the actual change harder to assess. -
The screenshots (
go-fasthttp-postgres-record.png,go-fasthttp-postgres-test1.png,fasthttp-postgres-test.png) were captured some time ago and the Keploy UI may have changed since then. Please verify these images still match the current output before merging, or replace them with fresh captures. -
The
QuickStartList.jsupdate adds a FastHTTP + Postgres entry. Please verify this entry uses the correct filter categories and icon, and that it doesn't duplicate or conflict with any existing entry for the FastHTTP sample in that file. -
There is inconsistent emoji usage across the new section headings (e.g., "Clone the sample CRUD application 🧪", "Lights, Camera, Record! 🎥", "Wrapping it up 🎉"). The repo has been moving toward removing emojis from headings in recent PRs - aligning with that direction would keep the style consistent across the quickstart guides.
-
The
curlexamples usehttp://localhost:8080/authorsfor POST buthttp://localhost:8080/booksfor GET, which may confuse readers following along with the FastHTTP CRUD app. Please confirm both endpoints exist in the sample app at those paths.
A rebase and screenshot refresh are the main blockers here. The content itself is solid and fills a real documentation gap.
What has changed?
This PR updates the FastHTTP + Postgres sample documentation to expose and document the existing Docker-based setup that was already implemented in the backend.
The changes include:
.mdfile to document both:This PR resolves #3269
Type of change
How Has This Been Tested?
imageChecklist: