Skip to content
/ FoxBot Public

πŸ¦ŠπŸ€–

License

Notifications You must be signed in to change notification settings

antfie/FoxBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

92 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

GitHub License GitHub go.mod Go version Go Report Card GitHub Release GitHub Downloads (all assets, all releases) Docker Image Size Docker Pulls

Introducing FoxBot

If a fox was a robot it would be fantastic. This is your very own personal robot, because you are fantastic. FoxBot is your AI-free1 personal assistant, diligently doing your chores in the background and letting you know about things important to you.

What Can It Do?

  • Poll your RSS feeds and notify you of relevant topics
  • Learn what you care about β€” a built-in Naive Bayes classifier learns from your feedback to filter out noise and surface the articles that matter to you
  • Detect changes to websites you care about
  • Daily reminders throughout the day about things to be mindful of, like drinking water
  • Countdown timers
  • Deliver notifications via console, Slack, or Telegram

Tip: For the best experience, use Telegram. RSS notifications come with inline πŸ‘/πŸ‘Ž buttons that train the classifier to understand your preferences. Over time FoxBot learns which topics you care about and suppresses the rest β€” no cloud services, no data leaving your device. See Intelligence for details.

How Do I Run It?

You can run this wherever you like. Just download the appropriate binary from here.

Using Docker

docker pull antfie/foxbot
docker run --rm -it -v "$(pwd):/app" antfie/foxbot

See the Deployment Guide for systemd, Raspberry Pi, and other options.

What Does It Look Like?

In the console you would see something like this:

console.png

However FoxBot really shines when you use it as a Slack or Telegram bot:

slack.png

How Do I Configure It?

A config.yaml file will be generated on first run. See the Configuration Guide for full details on all settings.

Documentation

Document Description
Configuration Guide All config options, keyword matching, feed groups
Intelligence How the Naive Bayes classifier learns from your feedback
Architecture System design, data flow diagrams, package structure
Deployment Guide Docker, systemd, Raspberry Pi, building from source

Running Locally

git clone https://github.com/antfie/FoxBot.git
go run github.com/antfie/FoxBot

How Can I Support This?

I welcome bug reports, fixes, features and donations to keep this going.

Buy Me A Coffee

Premium Features

If you need custom features, integrations or support we can help. Just email us at foxbot@antfie.com. We currently have the following premium feature availables:

  • Monitoring share prices with buy/sell notifications

Backlog

The following is a non-commital list of items we want to work through:

  • Speed test functionality, ping, ICMP
  • Consider daily summaries instead of regular updates
  • Solar panel monitoring
  • Weather
  • Home automation?

Credits

FoxBot was created by Anthony Fielding. Alert sounds by Material Design (Google), which are licenced under CC-BY 4.0.

Footnotes

  1. AI has been used to help build the robot, but there is no AI usage at runtime. ↩

About

πŸ¦ŠπŸ€–

Resources

License

Stars

Watchers

Forks

Sponsor this project

Contributors 2

  •  
  •