Update README.md

This commit is contained in:
PLUJA 2020-07-12 23:44:56 +02:00 committed by GitHub
parent 75124e529e
commit cb9fa3b03a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,2 +1,23 @@
# Parasitter
Follow Twitter with privacy.
> Twitter via RSS with privacy
Rssitter allows you to follow your favourite twitters without Twitter even knowing it. Rssitter uses [Nitter's](nitter.net) rss feed in order to gather the latest tweets from your favourite accounts and builds a *twitter-like* feed so you can read them. We will never connect you to Twitter so your privacy is safe when using Parasitter.
### Self hosting
1. Install `python3`, `pip` and `virtualenv`.
2. Prepare a virtual environment:
- `python3 -m venv venv`
- `source venv/bin/activate`
> Now you are inside of the virtual environment for python.
3. [env] Update pip
- `pip install --upgrade pip`
4. [env] Install the dependencies:
- `pip3 install flask flask-sqlalchemy flask-migrate python-dotenv flask-wtf flask-login email-validator feedparser`
> It may require you to use *sudo*
5. [env] Initialize and prepare the database.
- `flask db init`
- `flask db migrate`
- `flask db upgrade`
6. [env] Run the application.
- `flask run`
7. Go to "http://localhost:5000/" and enjoy.