Skip to content

Add live demo link to README #34

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
DarshanCodes09 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add live demo link to README #34

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8142e10
Add live demo link to README
DarshanCodes09 Feb 24, 2026
776d1d3
Add Live Demo section to README
DarshanCodes09 Feb 25, 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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,6 +659,9 @@ Open `index.html` in your browser to see all features.
Tutorial: https://youtu.be/cLJaT-8rEvQ?si=CLipA0Db4WL0EqKM

---
## Live Demo

👉 https://darshancodes09.github.io/SocialShareButton/

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Feb 24, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if GitHub Pages is configured and get repo details
# Using git and basic shell commands to inspect repo metadata

# First, check if this is the right repo
cd . && git remote -v | head -5

# Try to get basic info about the repo (if .github configs exist)
if [ -d ".github" ]; then
  echo "=== .github directory contents ==="
  find .github -type f | head -20
fi

# Check for deploy workflows that might indicate GitHub Pages
echo "=== Checking for deployment-related files ==="
find . -maxdepth 3 -name "*.yml" -o -name "*.yaml" | grep -E "(deploy|workflow|pages)" | head -10

# Look for any GitHub Pages configuration hints in the codebase
echo "=== Looking for Pages-related configuration ==="
rg -i "pages\|github\.io" --type md --max-count 10

Repository: AOSSIE-Org/SocialShareButton

Length of output: 419

🌐 Web query:

Is the URL https://darshancodes09.github.io/SocialShareButton/ currently live and accessible

💡 Result:

Yes. As of February 24, 2026, https://darshancodes09.github.io/SocialShareButton/ is live and accessible (it loads the “SocialShareButton Demo - Modern Social Sharing Component” page). [1]

The demo URL is live, but it's hosted on a personal GitHub Pages account rather than the organization's.

The URL https://darshancodes09.github.io/SocialShareButton/ is currently accessible, but note that it points to a personal GitHub Pages account (darshancodes09) rather than the AOSSIE-Org account. This creates a maintenance risk: if the account ownership changes or access is lost, the link will break. Consider discussing whether the demo should be hosted under the organization's GitHub Pages for long-term sustainability.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 662 - 665, The Live Demo link currently points to a
personal GitHub Pages site
(https://darshancodes09.github.io/SocialShareButton/); update the README under
the "Live Demo" section to point to the organization's GitHub Pages (or a
placeholder org-hosted URL) and/or add a note that the demo should be hosted
under the AOSSIE-Org account for long-term stability; coordinate moving the
deployed site to the AOSSIE-Org repository (or change the URL to
https://AOSSIE-Org.github.io/SocialShareButton/ once deployed) and replace the
existing personal URL in the README.

Copy link
Copy Markdown
Author

@DarshanCodes09 DarshanCodes09 Feb 24, 2026

Choose a reason for hiding this comment

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

Thank you for the review.

Since external contributors cannot deploy GitHub Pages for the organization repository, the demo is currently hosted from my fork to demonstrate functionality.

The organization can later enable GitHub Pages on the main repository after merging this PR.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Feb 24, 2026

Choose a reason for hiding this comment

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

@DarshanCodes09, thank you for the clarification! That makes perfect sense.

You're absolutely right that external contributors don't have the permissions to configure GitHub Pages on the organization's repository. Hosting the demo from your fork is a practical and reasonable approach to provide a working demonstration for reviewers and users.

The maintainers can handle updating the GitHub Pages configuration and the README URL once this PR is merged. At that point, the URL can be updated from https://darshancodes09.github.io/SocialShareButton/ to https://AOSSIE-Org.github.io/SocialShareButton/ (or whichever URL the organization chooses to use).

This approach works well for now and provides immediate value. Great work on getting the demo online! 🎉

🧠 Learnings used 
Learnt from: kpj2006
Repo: AOSSIE-Org/SocialShareButton PR: 1
File: src/social-share-button.js:10-11
Timestamp: 2025-12-21T12:11:23.512Z
Learning: SSR compatibility is important for the SocialShareButton library (src/social-share-button.js) since it's designed for public library usage across multiple frameworks including SSR environments.

## Contributing

Expand Down