Skip to content

Latest commit

 

History

History
124 lines (77 loc) · 4.15 KB

README.md

File metadata and controls

124 lines (77 loc) · 4.15 KB
Raw

Bluniversal Comments

bluniversal-comments

Bluniversal Comments is a Chrome Extension enabling "universal comments" via Bluesky, directly on web pages. With this extension, you can view, comment, and engage with Bluesky discussions linked to any web page.

How to Use the Extension

Step 1: Download the Extension

  1. Visit the Releases page on the GitHub repository.
  2. Download the latest chrome-extension.zip file for the extension.

Step 2: Install the Extension

  1. Unpackage the .zip file to a directory on your computer.
  2. Open Chrome and navigate to chrome://extensions/.
  3. Enable Developer mode using the toggle switch in the top right corner of the page.
  4. Click the Load unpacked button.
  5. Select the directory where you unpackaged the .zip file.

Step 3: Use the Extension

  1. Open any supported webpage.
  2. Click the Bluniversal Comments extension icon in the browser toolbar.
  3. Log in to your Bluesky account using your username and app password via the Options page (accessible by right-clicking on the extension icon and then Options).
  4. Once logged in, interact with existing Bluesky discussions or start a new thread for the page you're viewing.

License

Bluniversal Comments is distributed under the Server Side Public License (SSPL). This Source-Available license ensures that:

  • You are free to view, modify, and use the source code for your purposes.
  • If you use this code to provide a public-facing service, you are required to release your service's source code under the same license terms.
  • The license protects the project against proprietary usage while encouraging collaborative improvement.

For more details, read the full SSPL License.

Features

  • Bluesky Thread Integration: Connect Bluesky discussions with any webpage.
  • Comment Interaction: Post, reply to, and like Bluesky threads directly from the extension.
  • Developer Mode Support: Easily test features using developer credentials during local development.
  • Intelligent Post Creation: Automatically detects if a thread exists for a page, or creates one if necessary.
  • Secure Authentication: Safeguards your Bluesky credentials with robust session handling.

Development Guide

Prerequisites

  • Node.js (version >=16)
  • SST for Lambda function deployment
  • A valid Bluesky account with app password credentials

Local Setup

  1. Clone the repository:

    git clone https://github.com/joneslloyd/bluniversal-comments.git
cd bluniversal-comments

  2. Install dependencies:

    npm install

  3. Start the development server:

    npm run dev

  4. Load the unpacked extension from the packages/wxt/dist directory in Chrome (chrome://extensions/).

Contributions

We welcome contributions to Bluniversal Comments! To contribute:

  1. Fork the repository and create a new branch.
  2. Make your changes and write tests.
  3. Submit a pull request with a clear description of the changes and their purpose.

Troubleshooting

Issue: "No active session found"

  • Ensure you’ve entered valid Bluesky credentials in the Options page.
  • If using Developer Mode, ensure your WXT_BS_DEV_USERNAME and WXT_BS_DEV_PASSWORD environment variables are correctly set.

Issue: "Failed to load comments"

  • Check your Bluesky login status and ensure the webpage supports Bluniversal Comments.
  • If the issue persists, consult the logs in Chrome's developer console for detailed error messages.

Support

For further assistance, please open an issue in the GitHub Issues page.

Credits

This is inspired by the work of the following Bluesky users:

(Original thread).