Skip to content

Conversation

@Nsanjayboruds
Copy link

Add Ruby + PostgreSQL Quickstart Guide

📝 Description

This PR adds a comprehensive quickstart guide for Ruby (Sinatra) with PostgreSQL integration, demonstrating how to use Keploy for automated API testing with Ruby applications.

🎯 Changes Made

  • ✅ Created new quickstart documentation: ruby-sinatra-postgres.md

    • Includes both Docker Compose and Local setup instructions
    • Complete CRUD API examples (GET, POST, PUT, DELETE)
    • Clear step-by-step Keploy record and test commands
    • Follows existing documentation style and structure
  • ✅ Added Ruby language support to QuickStartFilter.js

    • Added Ruby gem icon with official Ruby red color (#CC342D)
    • Enables filtering quickstarts by Ruby language
  • ✅ Registered quickstart in QuickStartList.js

    • Added entries for both Docker and Local environments
    • Properly linked to documentation sections
  • ✅ Updated sidebar navigation in version-4.0.0-sidebars.json

    • Added Ruby category under QuickStarts section
    • Maintains consistent structure with other languages

🔗 Related Repository

Sample application repository: https://github.com/Nsanjayboruds/keploy-ruby-postgresql-quickstart

✅ Pre-submission Checklist

  • Build passes locally (npm run build successful)
  • Design matches existing quickstarts
  • Both Docker and Local setup instructions included
  • Follows existing code patterns
  • Documentation is clear and beginner-friendly

📸 Preview

The quickstart covers:

  • Health check endpoint
  • Books CRUD operations
  • PostgreSQL database integration
  • Keploy record/replay workflows

🙏 Additional Notes

This is my first contribution to Keploy docs. Looking forward to feedback and happy to make any requested changes!

- Created comprehensive quickstart documentation for Ruby (Sinatra) with PostgreSQL
- Added Ruby language support to QuickStartFilter with gem icon
- Registered Ruby quickstart in QuickStartList for both Docker and Local setups
- Updated sidebar navigation to include Ruby category
- Build verified successfully with no errors

Signed-off-by: Nsanjayboruds <nishantborude555@gmail.com>
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new Ruby (Sinatra) + PostgreSQL quickstart and wires it into the Quickstarts UI and sidebar so users can discover and follow the guide.

Changes:

  • Added a new Ruby (Sinatra) + PostgreSQL Books CRUD quickstart doc (Docker + Local flows).
  • Added “Ruby” to the Quickstart language filter UI and registered Ruby quickstart entries in the list.
  • Added a Ruby category under QuickStarts in the v4.0.0 sidebar.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
versioned_sidebars/version-4.0.0-sidebars.json Adds Ruby category + doc entry under QuickStarts for v4.0.0 navigation.
versioned_docs/version-4.0.0/quickstart/ruby-sinatra-postgres.md New Ruby+Postgres quickstart guide content (Docker + Local).
src/components/QuickStartList.js Registers Ruby quickstarts (Docker + Local) in the Quickstarts catalog.
src/components/QuickStartFilter.js Adds Ruby as a selectable language with icon/color in the filter UI.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Nsanjayboruds Nsanjayboruds force-pushed the add-ruby-postgresql-quickstart branch from b5847d0 to 7cf26e7 Compare January 30, 2026 02:43
- Remove standalone docker-compose up --build step
- Add clear instructions to stop containers before running tests
- Prevent port-in-use conflicts and make workflow clearer
- Ensure users stop services after test completion
- Build verified successfully with no errors

Signed-off-by: Nsanjayboruds <nishantborude555@gmail.com>
@Nsanjayboruds Nsanjayboruds force-pushed the add-ruby-postgresql-quickstart branch from d1b6200 to 4f2b408 Compare January 30, 2026 02:45
@Nsanjayboruds
Copy link
Author

@copilot open a new pull request to apply changes based on the comments in this thread

1 similar comment
@Nsanjayboruds
Copy link
Author

@copilot open a new pull request to apply changes based on the comments in this thread

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.

1 participant