0
Fork 0
mirror of https://codeberg.org/SafeTwitch/safetwitch.git synced 2024-12-22 13:22:58 -05:00
safetwitch/README.md

37 lines
1.6 KiB
Markdown
Raw Normal View History

2023-03-25 17:15:22 -05:00
# twitch-frontend
twitch-frontend is a privacy respecting frontend for [twitch.tv](https://twitch.tv/)
The main advantages of twitch-frontend are:
- Private: Every request is proxied through the server, and no logs are kept.
- Lightweight: Compared to twitch, twitch-frontend is optimized for speed and usability. Scraping is the only current speed issue, but improves with caching
</br>
2023-03-27 10:31:44 -05:00
# Okay, but why?
It is impossible to use Twitch without being bombarded with tons of ads, multiple trackers, and enourmous page sizes and loading times. This project aims to fix these issues, by removing all trackers, have much smaller page sizes, and very fast loading times.
2023-03-25 17:15:22 -05:00
# Features
### User features
- [x] No connection to twitch/amazon
2023-03-27 10:31:44 -05:00
- [x] Lightweight on server and client
2023-03-25 17:15:22 -05:00
- [x] No Ads or tracking
- [x] No outside connections, only connection is the instance
- [x] Uses [Vue](https://vuejs.org/) for a speedy experience
- [x] No identifiable logs are kept (see [logs](#so-what-is-logged))
- [x] Much smaller pages compared to Twitch (<600kb compared to >8.2mb)
2023-03-27 10:31:44 -05:00
- [x] Follow streamers locally to have a more personalized feel
- [x] Infinite scrolling
2023-03-25 17:15:22 -05:00
### Technical features
- [x] Public API
- [x] No official APIs are used
2023-03-27 10:31:44 -05:00
- [x] No rate lim
2023-03-25 17:15:22 -05:00
- [x] Uses a custom Twitch webscraper
## So, what is logged?
You may have caught the "No identifiable logs are kept",
When the server encounters an error, a log is kept. The log only includes the error message, the time, and an id, which is also given to the user so the instance owner can investigate the issue. This is mainly only used for debugging, and can be disabled in the config.