Giter VIP home page Giter VIP logo

colin-xkl / feedcraft Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 612 KB

craft your feed at ease! 轻量级rss中间件, 提取全文, 翻译、摘要一站式服务

Home Page: https://feed-craft.colinx.one

License: GNU General Public License v3.0

Dockerfile 0.29% Go 17.26% HTML 2.35% JavaScript 1.29% TypeScript 32.61% Vue 45.04% Less 1.12% CSS 0.03%
docker feed rss selfhost awesome-self ai gemini gpt llm nlp openai

feedcraft's Introduction

logo.png

Feed Craft

Craft all your feed in one place!

author GitHub License GitHub Actions Workflow Status GitHub go.mod Go version GitHub Release GitHub Discussions Container Image Size On GHCR Static Badge Open Source Love

Doc: English(WIP) | 简体中文 | 繁体中文(WIP)

FeedCraft is a powerful tool to process your rss feeds as a middleware, use it to translate your feed, extract fulltext, emulate browser to render js-heavy page, use llm such as google gemini to generate brief for your rss article, use natural language to filter your rss feed, and more!

FeedCraft 是一个简单、强大的RSS 源处理工具,他可以作为一个中间件处理你的RSS源. 你可以用它来翻译、提取正文、模拟浏览器来渲染那些动态生成的网页并提取全文、通过大语言模型如Google Gemini来生成文章摘要、通过自然语言筛选文章等

快速开始

访问以下URL 即可快速调用FeedCraft对输入的RSS源进行指定的处理 /craft/{choose_craft_option}?input_url={input_rss_url}

FeedCraft中的几个核心概念:

  • Craft(工艺),指要如何处理一个rss源, 比如是要进行翻译,还是提取正文,还是AI生成摘要等

目前可用的几个选项(craft option):

  • proxy: 简易RSS代理, 不作任何处理
  • fulltext: 获取全文
  • fulltext-plus: 获取全文,但是会模拟浏览器渲染网页,适用于常规模式无法获取到文章内容,动态渲染内容的站点
  • introduction: 调用AI为文章生成摘要,附加在原文开头
  • translate-title: 调用AI翻译文章标题
  • translate-content: 调用AI翻译文章标题

你可以使用提供的demo站点快速开始体验 : https://feed-craft.colinx.one

*注意:Demo站点仅供体验使用

部署

你可以通过docker快速自行部署一个FeedCraft实例,以获得更好的使用体验. 下面为一个最小docker compose 示例:

version: "3"
services:
  app.feed-craft:
    image: ghcr.io/colin-xkl/feed-craft
    container_name: feed-craft
    restart: always
    ports:
      - 10088:8080  # 10088可替换为任何你想使用的端口
    environment:
      FC_PUPPETEER_HTTP_ENDPOINT: http://service.browserless:3000 # 替换为你自己的 browserless 或其他浏览器实例地址
      FC_REDIS_URI: redis://service.redis:6379/ # 替换为你自己的redis 实例地址
      FC_OPENAI_AUTH_KEY: skxxxxxx # 鉴权的key
      FC_OPENAI_DEFAULT_MODEL: gemini-pro/chatgpt-3.5/... # 默认使用的模型
      FC_OPENAI_ENDPOINT: https://xxxxxx # OPENAI API 或兼容平台的API接口路径

你也可以直接在一个compose文件中把redis等附加组件也一起部署好:

version: "3"
services:
  app.feed-craft:
    image: ghcr.io/colin-xkl/feed-craft
    container_name: feed-craft
    restart: always
    ports:
      - 10088:8080  # 10088可替换为任何你想使用的端口
    environment:
      FC_PUPPETEER_HTTP_ENDPOINT: http://service.browserless:3000 # 替换为你自己的 browserless 或其他浏览器实例地址
      FC_REDIS_URI: redis://service.redis:6379/ # 替换为你自己的redis 实例地址
      FC_OPENAI_AUTH_KEY: skxxxxxx # 鉴权的key
      FC_OPENAI_DEFAULT_MODEL: gemini-pro/chatgpt-3.5/... # 默认使用的模型
      FC_OPENAI_ENDPOINT: https://xxxxxx # OPENAI API 或兼容平台的API接口路径
  service.redis:
    image: redis:6-alpine
    container_name: feedcraft_redis
    restart: always
  service.browserless:
    image: browserless/chrome
    container_name: feedcraft_browserless
    environment:
      USE_CHROME_STABLE: true
    restart: unless-stopped

关于FeedCraft

FeedCraft 的名称和Logo参考并致敬两款游戏: MineCraft和塞尔达, 初衷和愿景是做一个简单易用、同时足够灵活, 能够有更多可能性的RSS工具. 使用问题、建议等欢迎在Discussion区讨论交流

RoadMap

  • common openai api calling
  • translate article and title
  • feed combination support
  • feed limit support
  • feed custom keyword filter support
  • feed natural language filter support

许可

GPLv3

feedcraft's People

Contributors

colin-xkl avatar dependabot[bot] avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.