From cc7cdb18b504ab1168b1a3675747a588c380704b Mon Sep 17 00:00:00 2001 From: Pradeep Agrawal Date: Mon, 11 Mar 2024 20:05:13 -0500 Subject: [PATCH] Readme fix for installation instructions --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ef2b5f..2e726c6 100644 --- a/README.md +++ b/README.md @@ -5,26 +5,34 @@ [!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/zhymabekroman) ## FAQ + ### What is happened to GitHub organization? + Our whole Github organization is not public for now. Reddit community, that was beginning all of that unfourtunately also gone. So we have moved to Codeberg ### Why did we create Freedium? + In mid-June to mid-July 2023, Medium changed their paywall method, and all old paywall bypass methods we had stopped working. So I became obsessed with the idea of creating a service to bypass Medium's paywalled posts. Honestly I am not a big fan of Medium, but I sometimes read articles to improve my knowledge. ### How does Freedium work? + In the first version of Freedium, we reverse-engineered Medium.com's GraphQL endpoints and built our own parser and toolkits to show you unpaywalled Medium posts. Unfortunately, Medium closed this loophole and nowadays we just pay subscriptions and share access through Freedium. Sometimes we got a bugs because of the self-written parser, but we are working to make Freedium bug-free. ### What language are being used? + We use Python, with Jinja template builder, and some JS magic in Frontend :) ### Wow! I would like to contribute to Freedium. How can I do that? + We need volunteers who have Medium subscriptions because we might get banned by Medium. And if you developer you can start from the this (https://codeberg.org/Freedium-cfd/web) repository. ### Plans, future? + Speed up Freedium, and probably create open source Medium frontend in next life ## Tech stack: -- FastAPI, Gunicorn, Unicorn as worker, + +- FastAPI, Gunicorn, Unicorn as worker, - Tailwinds CSS v3 - Dragonfly (Redis like key-value database) - Jinja2 @@ -33,7 +41,9 @@ Speed up Freedium, and probably create open source Medium frontend in next life - Sentry ## Local run: + Requirements: + - Python 3.9+ - pip - git @@ -45,6 +55,7 @@ git clone https://github.com/Freedium-cfd/web ./web cd ./web pip install -r requirements.txt # for linux also do: pip install -r requirements-fast.txt +pip install ./database-lib pip install ./core pip install ./rl_string_helper