Skip to content

Add Perl + MongoDB quickstart#774

Open
Akshat005Chaudhary wants to merge 1 commit intokeploy:mainfrom
Akshat005Chaudhary:akshat-branch-one
Open

Add Perl + MongoDB quickstart#774
Akshat005Chaudhary wants to merge 1 commit intokeploy:mainfrom
Akshat005Chaudhary:akshat-branch-one

Conversation

@Akshat005Chaudhary
Copy link
Copy Markdown

Added quickstart for another language (Perl)

Summary

This PR adds a new Perl + MongoDB Quickstart to the Keploy documentation (latest version: v4.0.0).
The guide is written to be beginner-friendly and demonstrates how to integrate Keploy with a Perl-based
application using MongoDB for integration testing.


What This Quickstart Covers

The new quickstart includes:

  • Local setup (run the Perl app without Docker)
  • Docker Compose setup (app + MongoDB container)
  • ✅ Keploy integration workflow
  • ✅ Working Record mode (keploy record)
  • ✅ Working Replay mode (keploy replay)
  • ✅ Step-by-step instructions with expected outputs
  • ✅ Clean terminal screenshots (white background) for Keploy commands

Docs Changes Included

This PR updates the docs website to properly surface the new quickstart:

  • Added quickstart page:

    • versioned_docs/version-4.0.0/quickstart/perl-mongo.md
  • Added sidebar entry:

    • versioned_sidebars/version-4.0.0-sidebars.json
  • Added Perl as a supported language in QuickStart filtering UI:

    • src/components/QuickStartFilter.js
  • Listed the quickstart in the QuickStart cards view (Local + Docker flows):

    • src/components/QuickStartList.js
  • Added required images under:

    • static/img/quickstart/perl-mongo/

Build and Validation

  • ✅ Docs build passes locally:
npm run build

Thanks for opening this pull request! If the tests fail, please feel free to reach out to us by leaving a comment down below and we will be happy to take a look.

Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you and congratulations 🎉 for opening your very first pull request in keploy

Copy link
Copy Markdown
Contributor

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

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

Hey @Akshat005Chaudhary, thanks for adding the quickstart—really appreciate the effort. Could you please include a short video showcasing your changes?

Also, please avoid making changes to the sidebar. I noticed updates to the test coverage integration as well—kindly avoid including unnecessary changes.

Additionally, please include the Keploy record and replay commands, making sure the commands are clearly visible. It would be great to have these commands documented for both Docker-based and non-Docker setups. Thanks

@Akshat005Chaudhary
Copy link
Copy Markdown
Author

Hey @Akshat005Chaudhary, thanks for adding the quickstart—really appreciate the effort. Could you please include a short video showcasing your changes?

Also, please avoid making changes to the sidebar. I noticed updates to the test coverage integration as well—kindly avoid including unnecessary changes.

Additionally, please include the Keploy record and replay commands, making sure the commands are clearly visible. It would be great to have these commands documented for both Docker-based and non-Docker setups. Thanks

Hi @Achanandhi-M, thanks for the feedback! I’ve taken care of the requested updates.

Here’s a short video demonstrating my changes and the updated docs site in action:
video link

Also, please let me know if you would prefer a video demonstrating the application working with Keploy integration as well, or if the current video covering the documentation changes is sufficient. I’d be happy to add another demo if required.

Thanks!

Copy link
Copy Markdown
Member

@amaan-bhati amaan-bhati left a comment

Choose a reason for hiding this comment

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

Thank you for adding Perl and MongoDB coverage and for providing the demo video - that is appreciated.

There are a couple of open items from the previous review that still need to be closed out:

Issues Found

1. Outstanding reviewer feedback

The previous review asked for clearer documentation of the keploy record and keploy test commands for both Docker and non-Docker setups. Please confirm this has been addressed and point to the specific sections.

2. Sidebar clarification needed

There was a question raised about removing the sidebar changes. The sidebar entries are actually necessary for the guide to be discoverable in the docs navigation - please clarify this with the reviewer and get explicit sign-off before resubmitting.

3. Sample repo verification

Please confirm the Perl and MongoDB sample app referenced in the guide is publicly accessible and that the steps have been end-to-end verified on a clean environment.

Please also rebase against main before resubmitting as there are merge conflicts with other open PRs touching the same files.

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.

3 participants