Skip to content

Add Ruby + PostgreSQL quickstart guide #773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nsanjayboruds wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add Ruby + PostgreSQL quickstart guide #773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ba4b880
docs: add ruby postgresql quickstart
Nsanjayboruds Feb 3, 2026
0718d0a
add images of lcoal steups
Nsanjayboruds Feb 3, 2026
e68ccf8
docs: fix ruby quickstart review feedback
Nsanjayboruds Apr 10, 2026
e0645f0
Merge branch 'main' into add-ruby-postgresql-quickstart
Nsanjayboruds Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 119 additions & 30 deletions src/components/QuickStartFilter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,16 @@ import React, {useState} from "react";
import quickstarts from "./QuickStartList";
import Link from "@docusaurus/Link";
import {FaGolang} from "react-icons/fa6";
import {FaJava, FaLaptopCode, FaDocker, FaPython, FaCheck, FaArrowRight, FaArrowLeft} from "react-icons/fa";
import {
FaJava,
FaLaptopCode,
FaDocker,
FaPython,
FaCheck,
FaArrowRight,
FaArrowLeft,
FaGem,
} from "react-icons/fa";
import {TbBrandCSharp} from "react-icons/tb";
import {IoLogoJavascript} from "react-icons/io5";
import {useColorMode} from "@docusaurus/theme-common";
Expand All @@ -28,16 +37,38 @@ export default function QuickstartFilter({defaultLanguage = null}) {
{name: "Java", icon: <FaJava size={24} />, color: "#007396"},
{name: "JS/TS", icon: <IoLogoJavascript size={24} />, color: "#F7DF1E"},
{name: "C#", icon: <TbBrandCSharp size={24} />, color: "#512BD4"},
{name: "Ruby", icon: <FaGem size={24} />, color: "#CC342D"},
];

const servers = [
{name: "Local", icon: <FaLaptopCode size={24} />, description: "Run directly on your machine"},
{name: "Docker", icon: <FaDocker size={24} />, description: "Run in a Docker container"},
{
name: "Local",
icon: <FaLaptopCode size={24} />,
description: "Run directly on your machine",
},
{
name: "Docker",
icon: <FaDocker size={24} />,
description: "Run in a Docker container",
},
];

const steps = [
{id: 1, label: "Language", icon: languages.find(l => l.name === language)?.icon || null},
{id: 2, label: "Environment", icon: server === "Docker" ? <FaDocker size={16} /> : server === "Local" ? <FaLaptopCode size={16} /> : null},
{
id: 1,
label: "Language",
icon: languages.find((l) => l.name === language)?.icon || null,
},
{
id: 2,
label: "Environment",
icon:
server === "Docker" ? (
<FaDocker size={16} />
) : server === "Local" ? (
<FaLaptopCode size={16} />
) : null,
},
{id: 3, label: "Quickstart", icon: null},
];

Expand Down Expand Up @@ -67,7 +98,7 @@ export default function QuickstartFilter({defaultLanguage = null}) {
};

return (
<div className={`quickstart-wizard ${isDark ? 'dark' : 'light'}`}>
<div className={`quickstart-wizard ${isDark ? "dark" : "light"}`}>
<style>{`
.quickstart-wizard {
margin-top: 1.5rem;
Expand Down Expand Up @@ -366,20 +397,32 @@ export default function QuickstartFilter({defaultLanguage = null}) {
<div className="wizard-stepper">
{steps.map((step, idx) => (
<React.Fragment key={step.id}>
<div className={`wizard-step ${currentStep === step.id ? 'active' : ''} ${currentStep > step.id ? 'completed' : ''}`}>
<div
className={`wizard-step ${
currentStep === step.id ? "active" : ""
} ${currentStep > step.id ? "completed" : ""}`}
>
<div className="wizard-step-icon">
{currentStep > step.id ? <FaCheck size={12} /> : step.id}
</div>
<span>{step.label}</span>
{currentStep > step.id && step.id === 1 && language && (
<span style={{color: '#ff914d', marginLeft: '0.25rem'}}>({language})</span>
<span style={{color: "#ff914d", marginLeft: "0.25rem"}}>
({language})
</span>
)}
{currentStep > step.id && step.id === 2 && server && (
<span style={{color: '#ff914d', marginLeft: '0.25rem'}}>({server})</span>
<span style={{color: "#ff914d", marginLeft: "0.25rem"}}>
({server})
</span>
)}
</div>
{idx < steps.length - 1 && (
<div className={`wizard-step-connector ${currentStep > step.id ? 'completed' : ''}`} />
<div
className={`wizard-step-connector ${
currentStep > step.id ? "completed" : ""
}`}
/>
)}
</React.Fragment>
))}
Expand All @@ -391,18 +434,27 @@ export default function QuickstartFilter({defaultLanguage = null}) {
{currentStep === 1 && (
<>
<h3 className="wizard-title">Select your language</h3>
<p className="wizard-subtitle">Choose the programming language for your application</p>
<p className="wizard-subtitle">
Choose the programming language for your application
</p>
<div className="wizard-options">
{languages.map((lang) => (
<button
key={lang.name}
className={`wizard-option ${language === lang.name ? 'selected' : ''}`}
className={`wizard-option ${
language === lang.name ? "selected" : ""
}`}
onClick={() => handleLanguageSelect(lang.name)}
>
<div className="wizard-option-radio">
{language === lang.name && <FaCheck size={10} color="#fff" />}
{language === lang.name && (
<FaCheck size={10} color="#fff" />
)}
</div>
<div className="wizard-option-icon" style={{color: lang.color}}>
<div
className="wizard-option-icon"
style={{color: lang.color}}
>
{lang.icon}
</div>
<span className="wizard-option-label">{lang.name}</span>
Expand All @@ -416,30 +468,58 @@ export default function QuickstartFilter({defaultLanguage = null}) {
{currentStep === 2 && (
<>
<h3 className="wizard-title">Select your environment</h3>
<p className="wizard-subtitle">Choose where you want to run the application server</p>
<div className="wizard-options" style={{gridTemplateColumns: 'repeat(auto-fill, minmax(220px, 1fr))'}}>
<p className="wizard-subtitle">
Choose where you want to run the application server
</p>
<div
className="wizard-options"
style={{
gridTemplateColumns: "repeat(auto-fill, minmax(220px, 1fr))",
}}
>
{servers.map((srv) => (
<button
key={srv.name}
className={`wizard-option ${server === srv.name ? 'selected' : ''}`}
className={`wizard-option ${
server === srv.name ? "selected" : ""
}`}
onClick={() => handleServerSelect(srv.name)}
style={{flexDirection: 'column', alignItems: 'flex-start', gap: '0.5rem'}}
style={{
flexDirection: "column",
alignItems: "flex-start",
gap: "0.5rem",
}}
>
<div style={{display: 'flex', alignItems: 'center', gap: '0.75rem', width: '100%'}}>
<div
style={{
display: "flex",
alignItems: "center",
gap: "0.75rem",
width: "100%",
}}
>
<div className="wizard-option-radio">
{server === srv.name && <FaCheck size={10} color="#fff" />}
</div>
<div className="wizard-option-icon">
{srv.icon}
{server === srv.name && (
<FaCheck size={10} color="#fff" />
)}
</div>
<div className="wizard-option-icon">{srv.icon}</div>
<span className="wizard-option-label">{srv.name}</span>
</div>
<p className="wizard-option-desc" style={{marginLeft: '3.5rem'}}>{srv.description}</p>
<p
className="wizard-option-desc"
style={{marginLeft: "3.5rem"}}
>
{srv.description}
</p>
</button>
))}
</div>
<div className="wizard-actions">
<button className="wizard-btn wizard-btn-secondary" onClick={goBack}>
<button
className="wizard-btn wizard-btn-secondary"
onClick={goBack}
>
<FaArrowLeft size={12} /> Back
</button>
</div>
Expand All @@ -451,11 +531,15 @@ export default function QuickstartFilter({defaultLanguage = null}) {
<>
<div className="wizard-selection-summary">
<span className="wizard-selection-tag">
{languages.find(l => l.name === language)?.icon}
{languages.find((l) => l.name === language)?.icon}
{language}
</span>
<span className="wizard-selection-tag">
{server === "Docker" ? <FaDocker size={14} /> : <FaLaptopCode size={14} />}
{server === "Docker" ? (
<FaDocker size={14} />
) : (
<FaLaptopCode size={14} />
)}
{server}
</span>
<button className="wizard-reset-btn" onClick={resetSelection}>
Expand All @@ -465,8 +549,10 @@ export default function QuickstartFilter({defaultLanguage = null}) {
<h3 className="wizard-title">✨ Recommended Quickstarts</h3>
<p className="wizard-subtitle">
{filteredQuickstarts.length > 0
? `Found ${filteredQuickstarts.length} quickstart${filteredQuickstarts.length > 1 ? 's' : ''} for ${language} with ${server}`
: 'No quickstarts available for this selection'}
? `Found ${filteredQuickstarts.length} quickstart${
filteredQuickstarts.length > 1 ? "s" : ""
} for ${language} with ${server}`
: "No quickstarts available for this selection"}
</p>
<div className="wizard-results">
{filteredQuickstarts.map((app, idx) => (
Expand All @@ -480,7 +566,10 @@ export default function QuickstartFilter({defaultLanguage = null}) {
))}
</div>
<div className="wizard-actions">
<button className="wizard-btn wizard-btn-secondary" onClick={goBack}>
<button
className="wizard-btn wizard-btn-secondary"
onClick={goBack}
>
<FaArrowLeft size={12} /> Back
</button>
</div>
Expand Down
20 changes: 20 additions & 0 deletions src/components/QuickStartList.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,26 @@ const quickstarts = [
link: "/docs/quickstart/flask-redis/",
},

// Ruby list

{
title: "Ruby + Postgres",
language: "Ruby",
server: "Docker",
description:
"A sample Books CRUD API to demonstrate how seamlessly Keploy integrates with Ruby (Sinatra) and PostgreSQL.",
link: "/docs/quickstart/samples-ruby/#using-docker-compose-",
},

{
title: "Ruby + Postgres",
language: "Ruby",
server: "Local",
description:
"A sample Books CRUD API to demonstrate how seamlessly Keploy integrates with Ruby (Sinatra) and PostgreSQL.",
link: "/docs/quickstart/samples-ruby/#running-app-locally-on-linuxwsl-",
},

Comment on lines +309 to +328
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

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

src/components/QuickStartFilter is imported by versioned docs pages (e.g., version-3.0.0 quickstart pages). Since QuickStartList is shared across all versions, adding v4-only Ruby links here will surface Ruby quickstarts in older doc versions where /quickstart/samples-ruby doesn’t exist. Consider making the list version-aware or adding the Ruby quickstart doc+sidebar entries to the older supported versions.

Suggested change
// Ruby list
{
title: "Ruby + Postgres",
language: "Ruby",
server: "Docker",
description:
"A sample Books CRUD API to demonstrate how seamlessly Keploy integrates with Ruby (Sinatra) and PostgreSQL.",
link: "/docs/quickstart/samples-ruby/#using-docker-compose-",
},
{
title: "Ruby + Postgres",
language: "Ruby",
server: "Local",
description:
"A sample Books CRUD API to demonstrate how seamlessly Keploy integrates with Ruby (Sinatra) and PostgreSQL.",
link: "/docs/quickstart/samples-ruby/#running-app-locally-on-linuxwsl-",
},
// Ruby quickstarts are intentionally excluded from this shared list because
// older versioned docs pages also import this component and do not include
// /docs/quickstart/samples-ruby. Add them back only when this list becomes
// version-aware or when the Ruby quickstart docs exist in all supported versions.

Copilot uses AI. Check for mistakes.
//Javascript list

/* {
Expand Down
Binary file added static/img/ruby_keploy.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/ruby_postgrel_docker_setup.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/ruby_quickstart_docker_compose.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/ruby_testcase.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading