Skip to content
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.

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

add(app): 13ft Ladder #4653

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

add(app): 13ft Ladder #4653

wants to merge 6 commits into from

Conversation

cori
Copy link
Contributor

@cori cori commented Sep 2, 2024

Self-hosted 12ft.io - route around paywalls by pretending to be Googlebot.

Lots of sites have wised up to this approach, but the creator is active so perhaps new methods will evolve.

Very simple, light-weight site and config.

Summary by CodeRabbit

  • New Features

    • Introduced the "13 Feet Ladder" application as a self-hosted alternative to 12ft.io, enabling users to bypass paywalls and ads on various websites.
    • Implemented Docker Compose configuration for enhanced deployment and routing management.
  • Documentation

    • Created a description.md file providing a comprehensive overview and step-by-step usage guide for the application.
  • Chores

    • Added a config.json file containing essential metadata and configuration settings for the application.

cori and others added 3 commits August 22, 2024 12:25
basically as generated by OpenRouter's Perplexity Llama 3.1 Sonar Large
Online with a tailored prompt

I edited the categories a bit and that's it. i even left the keywords
for an AI-generated logo in there :headdesk:
fully-qualified image and fix up version

subsequent "final" clean up

- clean up description.md to communicate the project goals rather than
the functional facts; remove extraneous output
- add version tag to docker-compose image definition
- updates to config.json to match other changes
Copy link
Contributor

coderabbitai bot commented Sep 2, 2024

Walkthrough

The changes introduce a new application called "13 Feet Ladder," designed as a self-hosted alternative to 12ft.io for bypassing paywalls and ads on various websites. This includes the addition of configuration files such as config.json, docker-compose.yml, and description.md, which provide the application's metadata, deployment settings, and user instructions.

Changes

Files Change Summary
apps/13ft/config.json New file providing metadata and configuration settings for the "13 Feet Ladder" application.
apps/13ft/docker-compose.yml New Docker Compose configuration for deploying the "13ft" service with networking and routing settings.
apps/13ft/metadata/description.md New file offering a comprehensive overview and user manual for the "13 Feet Ladder" application.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@cori
Copy link
Contributor Author

cori commented Sep 2, 2024

I have it running at https://13ft.407.lol and it's currently in my custom repo at https://github.com/cori/runtipi-appstore/tree/coris-apps

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (4)
apps/13ft/metadata/description.md (4)

1-4: The introduction provides a clear overview of the app.

For consistency, consider using a hyphen in "self-hosted":

-A site similar to [12ft.io](https://12ft.io) but is self hosted and works with websites that 12ft.io doesn't work with.
+A site similar to [12ft.io](https://12ft.io) but is self-hosted and works with websites that 12ft.io doesn't work with.
Tools
LanguageTool

[misspelling] ~3-~3: This word is normally spelled with a hyphen.
Context: ...ar to 12ft.io but is self hosted and works with websites that 12ft.io do...

(EN_COMPOUNDS_SELF_HOSTED)


5-8: The section provides useful information about the app's functionality.

Consider the following improvements:

  • Use a hyphen in "self-hosted" for consistency.
  • Add missing commas for clarity.
  • Replace the informal word "wanna" with "want to".
-This is a simple self hosted server that has a simple but powerful interface to block ads, paywalls, and other nonsense. Specially for sites like medium, new york times which have paid articles that you normally cannot read. Now I do want you to support the creators you benefit from but if you just wanna see one single article and move on with your day then this might be helpful
+This is a simple self-hosted server that has a simple but powerful interface to block ads, paywalls, and other nonsense. Specially for sites like medium, new york times, which have paid articles that you normally cannot read. Now I do want you to support the creators you benefit from, but if you just want to see one single article and move on with your day, then this might be helpful.
Tools
LanguageTool

[misspelling] ~7-~7: This word is normally spelled with a hyphen.
Context: ...th. ## What is this? This is a simple self hosted server that has a simple but powerful i...

(EN_COMPOUNDS_SELF_HOSTED)


[uncategorized] ~7-~7: A comma might be missing here.
Context: ...y for sites like medium, new york times which have paid articles that you normally ca...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~7-~7: A comma might be missing here.
Context: ...you to support the creators you benefit from but if you just wanna see one single ar...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[style] ~7-~7: The word ‘wanna’ is informal.
Context: ...eators you benefit from but if you just wanna see one single article and move on with...

(WANNA)


[uncategorized] ~7-~7: A comma might be missing here.
Context: ...ne single article and move on with your day then this might be helpful ## How does...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


9-12: The section provides a clear explanation of how the app works.

Consider adding the missing comma for clarity:

-It pretends to be GoogleBot (Google's web crawler) and gets the same content that google will get. Google gets the whole page so that the content of the article can be indexed properly and this takes advantage of that.
+It pretends to be GoogleBot (Google's web crawler) and gets the same content that google will get. Google gets the whole page so that the content of the article can be indexed properly, and this takes advantage of that.
Tools
LanguageTool

[uncategorized] ~11-~11: Possible missing comma found.
Context: ...e content of the article can be indexed properly and this takes advantage of that. ## H...

(AI_HYDRA_LEO_MISSING_COMMA)


45-49: The section provides a useful alternative method to use the app.

The abbreviation "e.g." requires two periods. Consider updating it:

-You can also append the destination url at the end of the 13ft address. (e.g if your server is running at `http://127.0.0.1:5013` then you can go to `http://127.0.0.1:5013/https://example.com` and it will provide the contents of `https://example.com`)
+You can also append the destination url at the end of the 13ft address. (e.g. if your server is running at `http://127.0.0.1:5013` then you can go to `http://127.0.0.1:5013/https://example.com` and it will provide the contents of `https://example.com`)
Tools
LanguageTool

[uncategorized] ~47-~47: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...on url at the end of the 13ft address. (e.g if your server is running at `http://12...

(E_G)

@cori
Copy link
Contributor Author

cori commented Sep 2, 2024

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (4)

@coderabbitai i pushed improvements in e00a05b

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
apps/13ft/metadata/description.md (1)

1-49: Excellent description and usage guide!

The file provides a clear and comprehensive description of the "13 Feet Ladder" application, its purpose, and how it works. The step-by-step instructions with screenshots are easy to follow.

Consider adding commas in the following places to improve readability:

-This is a self-hosted server that has a simple but powerful interface to block ads, paywalls, and other nonsense. Specially for sites like Medium or The New York Times which have paid articles that you normally cannot read.
+This is a self-hosted server that has a simple but powerful interface to block ads, paywalls, and other nonsense. Specially for sites like Medium or The New York Times, which have paid articles that you normally cannot read.

-Now I do want you to support the creators you benefit from, but if you just want to see one single article and move on with your day then this might be helpful.
+Now I do want you to support the creators you benefit from, but if you just want to see one single article and move on with your day, then this might be helpful.

-It pretends to be GoogleBot (Google's web crawler) and gets the same content that google will get. Google gets the whole page so that the content of the article can be indexed properly and this takes advantage of that.
+It pretends to be GoogleBot (Google's web crawler) and gets the same content that google will get. Google gets the whole page so that the content of the article can be indexed properly, and this takes advantage of that.

-You can also append the destination url at the end of the 13ft address. (e.g. if your server is running at `http://127.0.0.1:5013` then you can go to `http://127.0.0.1:5013/https://example.com` and it will provide the contents of `https://example.com`)
+You can also append the destination url at the end of the 13ft address. (e.g. if your server is running at `http://127.0.0.1:5013`, then you can go to `http://127.0.0.1:5013/https://example.com` and it will provide the contents of `https://example.com`)
Tools
LanguageTool

[uncategorized] ~7-~7: Possible missing comma found.
Context: ...y for sites like Medium or The New York Times which have paid articles that you norma...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~7-~7: A comma might be missing here.
Context: ...ne single article and move on with your day then this might be helpful. ## How doe...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~11-~11: Possible missing comma found.
Context: ...e content of the article can be indexed properly and this takes advantage of that. ## H...

(AI_HYDRA_LEO_MISSING_COMMA)


[typographical] ~47-~47: Consider adding a comma.
Context: ...er is running at http://127.0.0.1:5013 then you can go to `http://127.0.0.1:5013/ht...

(IF_THEN_COMMA)

Copy link
Contributor

coderabbitai bot commented Sep 2, 2024

@cori The improvements you made in commit e00a05b look great! The grammatical and stylistic changes enhance the readability and correctness of the documentation. Thanks for addressing the suggestions.

Analysis chain
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Retrieve the diff for commit e00a05b to review the changes made.
git show e00a05b

Length of output: 2174

Actions performed

Comments resolved.

@cori cori mentioned this pull request Sep 2, 2024
1 task
@cori cori force-pushed the cori/app/13ft branch 2 times, most recently from bc53bb2 to e00a05b Compare September 5, 2024 12:11
@JigSawFr JigSawFr self-assigned this Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants