safetwitch/README.md

# SafeTwitch

<a href="https://translate.codeberg.org/engage/safetwitch/">
<img src="https://translate.codeberg.org/widget/safetwitch/frontend/svg-badge.svg" alt="Translation status" />
</a>

SafeTwitch is a privacy respecting frontend for [twitch.tv](https://twitch.tv/)

The main advantages of SafeTwitch are:

- Private: Every request is proxied through the server, and no logs are kept.
- Lightweight: Compared to twitch, SafeTwitch is optimized for speed and usability.

</br>

You can visit it here, the official instance, at https://safetwitch.drgns.space  
Or, you can find community instances [here](#instances)!

Do you want to help translate? You can do it over here on weblate! [Translate](#translate)

# 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.

# Features

### User features

- [x] No connection to twitch/amazon
- [x] Lightweight on server and client
- [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 logs
- [x] Much smaller pages compared to Twitch (<1.6mb with images compared to >8.2mb)
- [x] Follow streamers locally to have a more personalized feel
- [x] Infinite scrolling
- [x] Proxied WebSocket IRC

### Technical features

- [x] Public API
- [x] No official APIs are used
- [x] No rate limiting
- [x] Uses a custom Twitch webscraper

It's not all sunshine and rainbows though, and still has various cons, including

- SafeTwitch was a learning project
- dragongoose is silly (can't even drive yet 😔)
- Uses Vue, which relies on Javascript

You aren't forced to use SafeTwitch, so use whatever suits you the most!
Heres some other notable twitch projects

- [Xtra](https://f-droid.org/packages/com.github.andreyasadchy.xtra/), a Twitch client focused on providing the best viewing and chatting experience on mobile devices
- [Twire](https://f-droid.org/packages/com.perflyst.twire/), an ad free Twitch browser and stream player for Android.
- [Streamlink Twitch Gui](https://streamlink.github.io/streamlink-twitch-gui/), A multi platform Twitch.tv browser for Streamlink
- [Twineo](https://codeberg.org/CloudyyUw/twineo), A alternative twitch frontend

# Screenshots

| Images                                              | More Images                                         |
| --------------------------------------------------- | --------------------------------------------------- |
| ![ Photo of stream ](images/home.png "title")       | ![ Photo of stream ](images/stream.png "title")     |
| ![ Photo of category ](images/category.png "title") | ![ Photo of streamer ](images/streamer.png "title") |

# Donations

Donations towards development are not accepted. I really thank you for feeling the need to donate, it does mean a lot to me!

Instead, please donate your money to one of these charities which mean a lot to me.

- [American Foundation for Suicide Prevention](https://afsp.org/)
- [Boys and Girls Club of America](https://www.bgca.org/ways-to-give)

# Getting Started

All documentation can be found on the [wiki](https://codeberg.org/SafeTwitch/safetwitch/wiki)

## Translate

<a href="https://translate.codeberg.org/engage/safetwitch/">
  <img src="https://translate.codeberg.org/widgets/safetwitch/-/frontend/multi-auto.svg" alt="Translation status" />
</a>

Translating is a great way to help contribute! Even if it's only one word, anything helps!

You can translate here: https://translate.codeberg.org/projects/safetwitch/frontend/

## Instances

If you host a SafeTwitch instance and would like it to be listed in the readme, please make an issue or a pull request to add it in.

### Clearnet

| URL                                                                         | Country        | Info                                                                                               | Cloudflare |
|-----------------------------------------------------------------------------|----------------|----------------------------------------------------------------------------------------------------| ---------- |
| [safetwitch.drgns.space \(Official\)](https://safetwitch.drgns.space/)      | 🇺🇸           | Homelab                                                                                            | ❌         |
| [safetwitch.projectsegfau.lt](https://safetwitch.projectsegfau.lt/)         | 🇺🇸 🇮🇳 🇫🇷 | #2                                                                                                 | ❌         |
| [stream.whateveritworks.org](https://stream.whateveritworks.org)            | 🇩🇪           | Hosted on Hetzner/Dedicated Server with Encryption at rest                                         | ✅         |
| [safetwitch.datura.network](https://safetwitch.datura.network)              | 🇩🇪           | #9                                                                                                 | ❌         |
| [ttv.vern.cc](https://ttv.vern.cc)                                          | 🇺🇸           | #12                                                                                                | ❌         |
| [safetwitch.frontendfriendly.xyz](https://safetwitch.frontendfriendly.xyz/) | 🇺🇸           | #16                                                                                                | ❌         |
| [ttv.femboy.band](https://ttv.femboy.band)                                  | 🇩🇪           | #29                                                                                                | ❌         |
| [twitch.seitan-ayoub.lol](https://twitch.seitan-ayoub.lol)                  | 🇩🇪           | Hetnzer VPS                                                                                        | ❌         |
| [st.ggtyler.dev](https://st.ggtyler.dev)                                    | 🇺🇸           | [See ggtyler's frontend list for more info and locations](https://www.ggtyler.dev/other/frontends) | ❌         |
| [safetwitch.lunar.icu](https://safetwitch.lunar.icu)                        | 🇩🇪           | [See lunar.icu's site for more info](https://lunar.icu)                                            | ❌         |
| [twitch.sudovanilla.com](https://twitch.sudovanilla.com)                    | 🇺🇸           | Selfhosted                                                                                         | ✅         |
| [safetwitch.r4fo.com](https://safetwitch.r4fo.com)                          | 🇩🇪           | #80                                                                                                | ✅         |
| [safetwitch.ducks.party](https://safetwitch.ducks.party)                    | 🇳🇱           | Timeweb VPS                                                                                        | ❌         |
| [safetwitch.nogafam.fr](https://safetwitch.nogafam.fr)                      | 🇫🇷           | [See NoGafam services](https://nogafam.fr)                                                         | ❌          |

### Onion

| URL                                                                                        | Country | Info |
| ------------------------------------------------------------------------------------------ | ------- | ---- |
| [Onion vern.cc](http://ttv.vernccvbvyi5qhfzyqengccj7lkove6bjot2xhh5kajhwvidqafczrad.onion) | 🇺🇸      | #12  |

### I2P

| URL                                                                                | Country | Info |
| ---------------------------------------------------------------------------------- | ------- | ---- |
| [i2p vern.cc](http://vernz43kgqiy3nzzof3nejeo4hh3bjgyqi3b3hijchilv7noqtrq.b32.i2p) | 🇺🇸      | #12  |
Update 'README.md' 2023-04-08 22:09:35 +00:00			`# SafeTwitch`
update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00
Add translation progress 2023-09-16 22:13:49 +00:00			`<a href="https://translate.codeberg.org/engage/safetwitch/">`
			`<img src="https://translate.codeberg.org/widget/safetwitch/frontend/svg-badge.svg" alt="Translation status" />`
			`</a>`
Add documentation 2023-04-27 15:43:34 +00:00
Update 'README.md' 2023-04-08 22:09:35 +00:00			`SafeTwitch is a privacy respecting frontend for [twitch.tv](https://twitch.tv/)`
Update README.md 2023-03-25 22:15:22 +00:00
Update 'README.md' 2023-04-08 22:09:35 +00:00			`The main advantages of SafeTwitch are:`
Add documentation 2023-04-27 15:43:34 +00:00
			`- Private: Every request is proxied through the server, and no logs are kept.`
			`- Lightweight: Compared to twitch, SafeTwitch is optimized for speed and usability.`

			`</br>`

Update url 2023-09-09 02:31:36 +00:00			`You can visit it here, the official instance, at https://safetwitch.drgns.space`
ProjectSegfault instance!!!! #2 2023-07-05 15:09:07 +00:00			`Or, you can find community instances [here](#instances)!`
Update 'README.md' 2023-05-17 12:16:30 +00:00
Update 'README.md' 2023-07-11 03:06:38 +00:00			`Do you want to help translate? You can do it over here on weblate! [Translate](#translate)`
Add translation notes 2023-06-13 16:09:21 +00:00
Add documentation 2023-04-27 15:43:34 +00: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.`

			`# Features`

			`### User features`

			`- [x] No connection to twitch/amazon`
			`- [x] Lightweight on server and client`
			`- [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 logs`
Update 'README.md' 2023-07-11 03:03:30 +00:00			`- [x] Much smaller pages compared to Twitch (<1.6mb with images compared to >8.2mb)`
Add documentation 2023-04-27 15:43:34 +00:00			`- [x] Follow streamers locally to have a more personalized feel`
Update 'README.md' 2023-08-02 15:16:34 +00:00			`- [x] Infinite scrolling`
			`- [x] Proxied WebSocket IRC`
Add documentation 2023-04-27 15:43:34 +00:00
			`### Technical features`

			`- [x] Public API`
			`- [x] No official APIs are used`
			`- [x] No rate limiting`
			`- [x] Uses a custom Twitch webscraper`

Update 'README.md' 2023-05-19 02:05:44 +00:00			`It's not all sunshine and rainbows though, and still has various cons, including`
update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00
Update 'README.md' 2023-05-19 02:05:44 +00:00			`- SafeTwitch was a learning project`
			`- dragongoose is silly (can't even drive yet 😔)`
			`- Uses Vue, which relies on Javascript`

			`You aren't forced to use SafeTwitch, so use whatever suits you the most!`
update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00			`Heres some other notable twitch projects`

Update 'README.md' 2023-05-19 02:05:44 +00:00			`- [Xtra](https://f-droid.org/packages/com.github.andreyasadchy.xtra/), a Twitch client focused on providing the best viewing and chatting experience on mobile devices`
			`- [Twire](https://f-droid.org/packages/com.perflyst.twire/), an ad free Twitch browser and stream player for Android.`
			`- [Streamlink Twitch Gui](https://streamlink.github.io/streamlink-twitch-gui/), A multi platform Twitch.tv browser for Streamlink`
Update 'README.md' 2023-07-21 15:15:26 +00:00			`- [Twineo](https://codeberg.org/CloudyyUw/twineo), A alternative twitch frontend`

			`# Screenshots`
Update 'README.md' 2023-05-19 02:05:44 +00:00
update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00			`\| Images \| More Images \|`
			`\| --------------------------------------------------- \| --------------------------------------------------- \|`
			`\| ![ Photo of stream ](images/home.png "title") \| ![ Photo of stream ](images/stream.png "title") \|`
			`\| ![ Photo of category ](images/category.png "title") \| ![ Photo of streamer ](images/streamer.png "title") \|`
Update README.md 2023-09-16 14:52:02 +00:00
Update 'README.md' 2023-04-16 18:04:08 +00:00			`# Donations`
Add documentation 2023-04-27 15:43:34 +00:00
Update 'README.md' 2023-05-19 02:05:44 +00:00			`Donations towards development are not accepted. I really thank you for feeling the need to donate, it does mean a lot to me!`
Update 'README.md' 2023-04-16 18:04:08 +00:00
			`Instead, please donate your money to one of these charities which mean a lot to me.`
update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00
Update 'README.md' 2023-04-16 18:04:08 +00:00			`- [American Foundation for Suicide Prevention](https://afsp.org/)`
Add documentation 2023-04-27 15:43:34 +00:00			`- [Boys and Girls Club of America](https://www.bgca.org/ways-to-give)`

			`# Getting Started`

update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00			`All documentation can be found on the [wiki](https://codeberg.org/SafeTwitch/safetwitch/wiki)`
Add documentation 2023-04-27 15:43:34 +00:00
Update 'README.md' 2023-07-11 03:06:38 +00:00			`## Translate`
update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00
Update 'README.md' 2023-07-11 03:06:38 +00:00			`<a href="https://translate.codeberg.org/engage/safetwitch/">`
			`<img src="https://translate.codeberg.org/widgets/safetwitch/-/frontend/multi-auto.svg" alt="Translation status" />`
			`</a>`

add message 2023-09-09 02:39:34 +00:00			`Translating is a great way to help contribute! Even if it's only one word, anything helps!`

Update 'README.md' 2023-07-11 03:06:38 +00:00			`You can translate here: https://translate.codeberg.org/projects/safetwitch/frontend/`

ProjectSegfault instance!!!! #2 2023-07-05 15:09:07 +00:00			`## Instances`
Add documentation 2023-04-27 15:43:34 +00:00
			`If you host a SafeTwitch instance and would like it to be listed in the readme, please make an issue or a pull request to add it in.`

Update 'README.md' 2023-08-03 19:24:14 +00:00			`### Clearnet`
update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00
Added safetwitch.nogafam.fr instance 2024-01-04 09:34:15 +00:00			`\| URL \| Country \| Info \| Cloudflare \|`
			`\|-----------------------------------------------------------------------------\|----------------\|----------------------------------------------------------------------------------------------------\| ---------- \|`
			`\| [safetwitch.drgns.space \(Official\)](https://safetwitch.drgns.space/) \| 🇺🇸 \| Homelab \| ❌ \|`
update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00			`\| [safetwitch.projectsegfau.lt](https://safetwitch.projectsegfau.lt/) \| 🇺🇸 🇮🇳 🇫🇷 \| #2 \| ❌ \|`
Added safetwitch.nogafam.fr instance 2024-01-04 09:34:15 +00:00			`\| [stream.whateveritworks.org](https://stream.whateveritworks.org) \| 🇩🇪 \| Hosted on Hetzner/Dedicated Server with Encryption at rest \| ✅ \|`
			`\| [safetwitch.datura.network](https://safetwitch.datura.network) \| 🇩🇪 \| #9 \| ❌ \|`
			`\| [ttv.vern.cc](https://ttv.vern.cc) \| 🇺🇸 \| #12 \| ❌ \|`
			`\| [safetwitch.frontendfriendly.xyz](https://safetwitch.frontendfriendly.xyz/) \| 🇺🇸 \| #16 \| ❌ \|`
			`\| [ttv.femboy.band](https://ttv.femboy.band) \| 🇩🇪 \| #29 \| ❌ \|`
			`\| [twitch.seitan-ayoub.lol](https://twitch.seitan-ayoub.lol) \| 🇩🇪 \| Hetnzer VPS \| ❌ \|`
			`\| [st.ggtyler.dev](https://st.ggtyler.dev) \| 🇺🇸 \| [See ggtyler's frontend list for more info and locations](https://www.ggtyler.dev/other/frontends) \| ❌ \|`
			`\| [safetwitch.lunar.icu](https://safetwitch.lunar.icu) \| 🇩🇪 \| [See lunar.icu's site for more info](https://lunar.icu) \| ❌ \|`
			`\| [twitch.sudovanilla.com](https://twitch.sudovanilla.com) \| 🇺🇸 \| Selfhosted \| ✅ \|`
			`\| [safetwitch.r4fo.com](https://safetwitch.r4fo.com) \| 🇩🇪 \| #80 \| ✅ \|`
			`\| [safetwitch.ducks.party](https://safetwitch.ducks.party) \| 🇳🇱 \| Timeweb VPS \| ❌ \|`
			`\| [safetwitch.nogafam.fr](https://safetwitch.nogafam.fr) \| 🇫🇷 \| [See NoGafam services](https://nogafam.fr) \| ❌ \|`
Add st.ggtyler.dev 2023-10-22 02:55:16 +00:00
Update 'README.md' 2023-08-03 19:24:14 +00:00			`### Onion`
update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00
			`\| URL \| Country \| Info \|`
			`\| ------------------------------------------------------------------------------------------ \| ------- \| ---- \|`
			`\| [Onion vern.cc](http://ttv.vernccvbvyi5qhfzyqengccj7lkove6bjot2xhh5kajhwvidqafczrad.onion) \| 🇺🇸 \| #12 \|`
Update 'README.md' 2023-08-03 19:15:44 +00:00
Update 'README.md' 2023-08-03 19:24:14 +00:00			`### I2P`
update my instance info, new org and formatting 2023-11-30 03:37:03 +00:00
			`\| URL \| Country \| Info \|`
			`\| ---------------------------------------------------------------------------------- \| ------- \| ---- \|`
			`\| [i2p vern.cc](http://vernz43kgqiy3nzzof3nejeo4hh3bjgyqi3b3hijchilv7noqtrq.b32.i2p) \| 🇺🇸 \| #12 \|`