nitter/README.md
2019-06-29 14:12:20 +02:00

58 lines
2 KiB
Markdown

# Nitter (WIP)
A free and open source alternative Twitter front-end focused on privacy. \
Inspired by the [invidio.us](https://github.com/omarroth/invidious) project.
- No JavaScript or ads
- All requests go through the backend, client never talks to Twitter
- Prevents Twitter from tracking your IP or JavaScript fingerprint
- Unofficial API (no rate limits or developer account required)
- AGPLv3 licensed, no proprietary instances permitted
- Dark theme
- Lightweight (for [@nim_lang](https://twitter.com/nim_lang), 36KB vs 580KB from twitter.com)
## Installation
```bash
git clone https://github.com/zedeus/nitter
cd nitter
nimble build
```
To run, `./nitter`. It's currently not possible to change any settings or things
like the title, this will change as the project matures a bit. For now the focus
is on implementing missing features.
## Todo (roughly in this order)
- "Show Thread" button
- Twitter "Cards" (link previews)
- Search (+ hashtag search)
- Hiding retweets, showing replies, etc.
- Emoji support (WIP, needs font)
- Nitter link previews
- Server configuration
- Caching (waiting for [moigagoo/norm#19](https://github.com/moigagoo/norm/pull/19))
- Simple account system with feed (excludes retweets)
- Media-only/gallery view
- Video support with hls.js
- Json API endpoints
- Themes
- Nitter logo
## Why?
It's basically impossible to use Twitter without JavaScript enabled. If you try,
you're redirected to the legacy mobile version which is awful both functionally
and aesthetically. For privacy-minded folks, preventing JavaScript analytics and
potential IP-based tracking is important, but apart from using the legacy mobile
version and a VPN, it's impossible. Using an instance of Nitter (hosted on a VPS
for example), you can essentially browse Twitter without JavaScript, while
retaining your privacy. In the future a simple account system will be added that
lets you follow Twitter users, allowing you to have a clean chronological
timeline without needing a Twitter account.
## Screenshot
![nitter](/screenshot.png)