Skip to content

Conversation

@Gagan202005
Copy link
Contributor

@Gagan202005 Gagan202005 commented Jan 29, 2026

🚀 Add Rust + MongoDB Quickstart Page to Keploy Docs Website

📌 Summary

This PR adds a Rust + MongoDB Quickstart guide to the Keploy documentation website.
The goal is to help Rust developers quickly understand and use Keploy’s record & replay workflow with a real-world MongoDB-backed REST API.


🔗 Related Issue

Closes : keploy/keploy#3521

✨ What’s Included

  • New Rust + MongoDB quickstart page under QuickStarts → Rust
  • Step-by-step guide for:
    • Running the app locally
    • Running the app using Docker Compose
    • Recording API calls with Keploy
    • Replaying tests with mocked MongoDB
  • Clear commands, explanations, and developer-friendly flow
  • Integrated with existing QuickStartFilter and sidebar navigation

📦 Sample Repository

This quickstart is based on the following reference implementation:

👉 Repo: https://github.com/Gagan202005/Keploy-Rust-Mongodb-QuickStart

Repo highlights:

  • Rust CRUD Notes REST API
  • MongoDB (Docker-based)
  • Keploy Record & Replay (Local + Docker)
  • Clean, minimal setup suitable for beginners

Requesting maintainers to please Add this repo to the keploy.


🧪 Testing Done

  • Verified docs page renders correctly in sidebar
  • Confirmed navigation from QuickStarts → Rust → MongoDB
  • Validated local & docker commands from the docs against the sample repo

Demo

Docs Website video :

Screen.Recording.2026-01-29.at.5.04.30.AM.mov

local setup testing :

Screen.Recording.2026-01-29.at.5.23.01.AM.mov

Docker setup testing :

Screen.Recording.2026-01-29.at.4.36.56.AM.mov

Thanks a lot for your time and review!

Signed-off-by: Gagan202005 <gagansinghal2005@gmail.com>
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 @Gagan202005, I’ve reviewed your quickstart, and it doesn’t fully follow our current style guidelines. Please align it with the existing format. It should include a short description explaining what the quickstart is about. Also, all our quickstarts include an image—please add one as well. We prefer not to include emojis, as it makes the content look AI-generated. Kindly check the existing quickstarts and follow the same structure and format.

You can use this as a reference: https://github.com/keploy/docs/blob/main/ADDING_A_QUICKSTART.md

Signed-off-by: Gagan202005 <gagansinghal2005@gmail.com>
Signed-off-by: Gagan202005 <gagansinghal2005@gmail.com>
@Gagan202005
Copy link
Contributor Author

Hey @Achanandhi-M
Thanks for the review and detailed feedback.

I’ve updated the quickstart to align with the existing style guidelines and structure. A concise description has been added at the top explaining the purpose of the quickstart, and I’ve included an images.

I’ve also removed emojis and adjusted the formatting to match the current quickstart format.

Please let me know if anything else needs refinement.

Screen.Recording.2026-01-30.at.4.00.36.PM.mov

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.

Add New Quickstarts for More Languages (Rust, Ruby, C++, Perl, PHP)

2 participants