Skip to content

Conversation

@Akshat005Chaudhary
Copy link

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

@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
Member

@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

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.

2 participants