mirror of
https://github.com/zyachel/quetre.git
synced 2025-04-03 21:17:36 +03:00
docs: Improve README.md and mention onion NO_UPGRADE
This commit is contained in:
NebulaOnion
GitHub
parent
64aedb1d95
commit
e46f4ad53f
1 changed files with 64 additions and 60 deletions
124
README.md
124
README.md
|
|
@ -1,4 +1,5 @@
|
|||
# Quetre
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/humanetech-community/awesome-humane-tech)
|
||||
|
|
@ -12,6 +13,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
Quetre is an alternative front-end to Quora.
|
||||
It enables you to see answers without ads, trackers, and other such bloat.
|
||||
|
||||
|
|
@ -19,27 +21,27 @@ It enables you to see answers without ads, trackers, and other such bloat.
|
|||
|
||||
## Key Features
|
||||
|
||||
- Privacy focused
|
||||
- **Privacy focused**
|
||||
|
||||
All requests are proxied which makes it impossible for Quora to collate meaningful data points about you.
|
||||
|
||||
- No ads or tracking
|
||||
- **No ads or tracking**
|
||||
|
||||
Absolutely no ads, no tracking, no browser fingerprinting, and no telemetry of any kind.
|
||||
|
||||
- Fully responsive layout
|
||||
- **Fully responsive layout**
|
||||
|
||||
Utilises modern CSS features like CSS Grid and Flexbox to make the website fully responsive for all screen sizes.
|
||||
|
||||
- Lightweight and fast
|
||||
- **Lightweight and fast**
|
||||
|
||||
As the website contains no bloat, pages load in a jiffy and request sizes are tiny.
|
||||
|
||||
- Dark and light themes
|
||||
- **Dark and light themes**
|
||||
|
||||
Whether you're a nightowl or bright screen lover, you'll enjoy curated color scheme for your taste.
|
||||
|
||||
- Unofficial API support
|
||||
- **Unofficial API support**
|
||||
|
||||
just add `/api/v1/` after the domain name in the URL and get a JSON response.
|
||||
|
||||
|
|
@ -86,11 +88,11 @@ It enables you to see answers without ads, trackers, and other such bloat.
|
|||
|
||||
---
|
||||
|
||||
## Comparision
|
||||
## Comparison
|
||||
|
||||
### Speed
|
||||
|
||||
URL for comparision: https://www.quora.com/How-does-the-Z-boson-decay
|
||||
URL for comparison: https://www.quora.com/How-does-the-Z-boson-decay
|
||||
|
||||
| | Quora | Quetre |
|
||||
| --------------- | --------- | -------- |
|
||||
|
|
@ -99,7 +101,7 @@ URL for comparision: https://www.quora.com/How-does-the-Z-boson-decay
|
|||
| Finish time | 2.44min\* | 4.62s |
|
||||
| Data consumed | 3.49MB | 404.47KB |
|
||||
|
||||
\*the requests were ongoing even after 6 minutes
|
||||
\*The requests were ongoing even after 6 minutes
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -113,44 +115,44 @@ URL for comparision: https://www.quora.com/How-does-the-Z-boson-decay
|
|||
|
||||
### Privacy
|
||||
|
||||
#### Quora(when browsing anonymously)
|
||||
#### Quora (when browsing "anonymously")
|
||||
|
||||
From [their privacy policy](https://www.quora.com/about/privacy)
|
||||
|
||||
- Technologies used
|
||||
- cookies
|
||||
- log files
|
||||
- clear GIFs/pixel tags
|
||||
- **Technologies used**
|
||||
- Cookies
|
||||
- Log files
|
||||
- Clear GIFs/pixel tags
|
||||
- JavaScript
|
||||
- web beacons
|
||||
- local storage objects
|
||||
- Web beacons
|
||||
- Local Storage Objects
|
||||
- Analytics Tools
|
||||
- other tracking technologies
|
||||
- Data collected
|
||||
- searches
|
||||
- page views
|
||||
- date and time of your visit
|
||||
- browser type
|
||||
- type of computer or mobile device
|
||||
- browser language
|
||||
- Other tracking technologies
|
||||
- **Data collected**
|
||||
- Searches
|
||||
- Page views
|
||||
- Date and time of your visit
|
||||
- Browser type
|
||||
- Type of computer or mobile device
|
||||
- Browser language
|
||||
- IP address
|
||||
- mobile carrier
|
||||
- unique device identifier
|
||||
- location
|
||||
- requested and referring URLs
|
||||
- other information about your use of the Quora Platform
|
||||
- Mobile carrier
|
||||
- Unique device identifier
|
||||
- Location
|
||||
- Requested and referring URLs
|
||||
- Other information about your use of the Quora Platform
|
||||
|
||||
#### Quetre
|
||||
|
||||
- Data actively collected by Quetre
|
||||
- **Data actively collected by Quetre**
|
||||
|
||||
None.
|
||||
|
||||
- Data passively collected by Quetre
|
||||
- **Data passively collected by Quetre**
|
||||
|
||||
Whenever you hit some error page, an error object is logged to the console on the server. That error object contains the resource url you were trying to access, and the usual stack trace. That's it.
|
||||
Whenever you hit some error page, an error object is logged to the console on the server. That error object contains the resource URL you were trying to access, and the usual stack trace. That's it.
|
||||
|
||||
- Data stored locally in your browser
|
||||
- **Data stored locally in your browser**
|
||||
|
||||
A key called 'theme' is stored in local storage provided by your browser to store your theme preference should you override the default theme. To prevent this behaviour, either disable JavaScript or local storage for Quetre.
|
||||
|
||||
|
|
@ -158,39 +160,39 @@ From [their privacy policy](https://www.quora.com/about/privacy)
|
|||
|
||||
## FAQs
|
||||
|
||||
- How do I use this?
|
||||
- **How do I use this?**
|
||||
|
||||
Replace 'www.quora.com' in any URL with 'quetre.iket.me'(or any other instance). So, 'https://www.quora.com/Are-Nubians-nilotes' becomes 'https://quetre.iket.me/Are-Nubians-nilotes'.
|
||||
Replace 'www.quora.com' in any URL with 'quetre.iket.me' (or any other instance). So, 'https://www.quora.com/Are-Nubians-nilotes' becomes 'https://quetre.iket.me/Are-Nubians-nilotes'.
|
||||
|
||||
- I don't want to edit the URLs manually!
|
||||
- **I don't want to edit the URLs manually!**
|
||||
|
||||
There are [a couple of solutions](#automatic-redirection) for that.
|
||||
|
||||
- There are some unreachable routes.
|
||||
- **There are some unreachable routes.**
|
||||
|
||||
I'm working to implement them soon. Keep an eye on [To-Do list](#to-do).
|
||||
|
||||
- Why are some math equations showing up weirdly?
|
||||
- **Why are some math equations showing up weirdly?**
|
||||
|
||||
If you're browsing with JavaScript disabled, then the Mathjax library isn't able to load and format tex equations. I'd recommend to enable JavaScript for it since there's no other way to show them in the browser. Even Quora uses Mathjax.
|
||||
|
||||
- Why can I only view a couple of answers?
|
||||
- **Why can I only view a couple of answers?**
|
||||
|
||||
Quora doesn't show all answers at once. It only loads more answers as the user scrolls down. Furthermore, it uses many unique IDs to send ajax requests to fetch those answers. So, all in all, getting more answers isn't impossible but quite difficult requiring some serious amount of time on their website in order to figure out how it all happens. I'm short on time for now.
|
||||
|
||||
- Why am I getting a _Recheck the URL_ error?
|
||||
- **Why am I getting a _Recheck the URL_ error?**
|
||||
|
||||
Sometimes Quora doesn't populate the answer page HTML, and hence, Quetre is unable to extract data from it. If that happens, you can refresh the page a couple of times to get the answers.
|
||||
|
||||
- I have some ideas/want to help.
|
||||
- **I have some ideas/want to help.**
|
||||
|
||||
You're most welcome to do that. Just [contact me](#contact) or fork [the repo](https://github.com/zyachel/quetre/fork) and make a pull request. You can even help by correcting some typos or translating this README to other languages.
|
||||
You're most welcome to do that. Just [contact me](#contact) or fork [the repo](https://github.com/zyachel/quetre/fork) and make a pull request. You can even help by correcting some typos or translating this README to other languages. *Please, read the [CONTRIBUTING.md](./CONTRIBUTING.md) beforehand.*
|
||||
|
||||
- Why the name Quetre?
|
||||
- **Why the name Quetre?**
|
||||
|
||||
Quora is [supposedly](https://www.quora.com/Why-is-Quora-called-Quora-4) a portmanteau of 'Questions or answers'. In the same vein, Quetre is a portmanteau of 'Questions and answers', but [in Latin](https://lingva.ml/en/la/questions%20and%20answers%0A).
|
||||
|
||||
- I cannot view the comments. Will you add that feature?
|
||||
- **I cannot view the comments. Will you add that feature?**
|
||||
|
||||
See [this issue](https://codeberg.org/zyachel/quetre/issues/11)
|
||||
|
||||
|
|
@ -198,12 +200,12 @@ From [their privacy policy](https://www.quora.com/about/privacy)
|
|||
|
||||
## To-Do
|
||||
|
||||
- [x] add missing routes like topics, profile, and search
|
||||
- [ ] use redis
|
||||
- [x] serve images and other assets from Quetre
|
||||
- [x] implement a better installation method
|
||||
- [ ] implement other trivial routes like a specific answer, spaces, etc.
|
||||
- [ ] implement a way to get more answers (not a big priority as of now)
|
||||
- [x] Add missing routes like topics, profile, and search
|
||||
- [ ] Use redis
|
||||
- [x] Serve images and other assets from Quetre
|
||||
- [x] Implement a better installation method
|
||||
- [ ] Implement other trivial routes like a specific answer, spaces, etc.
|
||||
- [ ] Implement a way to get more answers (not a big priority as of now)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -216,16 +218,18 @@ From [their privacy policy](https://www.quora.com/about/privacy)
|
|||
2. Clone and set up the repository.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/zyachel/quetre.git # replace github.com with codeberg.org if you're cloning from there
|
||||
git clone https://github.com/zyachel/quetre.git # Replace github.com with codeberg.org if you're cloning from there
|
||||
cd quetre
|
||||
cp .env.example .env # you can make any changes here
|
||||
# change `pnpm` to `npm run` here as well as in package.json if you use `npm`
|
||||
cp .env.example .env # You can make any changes here
|
||||
# Change `pnpm` to `npm run` here as well as in package.json if you use `npm`
|
||||
pnpm install
|
||||
pnpm start
|
||||
```
|
||||
|
||||
Quetre will start running at http://localhost:3000.
|
||||
|
||||
**Important: If you are running an .onion or I2P instance, set the `NO_UPGRADE` .env variable to "1", otherwise the page will be broken.**
|
||||
|
||||
### Docker
|
||||
|
||||
There is a [docker image](https://github.com/PussTheCat-org/docker-quetre-quay) made by [@TheFrenchGhosty](https://github.com/TheFrenchGhosty) for [PussTheCat.org](https://pussthecat.org/)'s [instance](https://quetre.pussthecat.org/).
|
||||
|
|
@ -235,9 +239,9 @@ If you want a leaner one, you can checkout [@video-prize-ranch](https://codeberg
|
|||
|
||||
## Contributing
|
||||
|
||||
The development may seem slow as I don't have lots of free time. And whenever I do, it gets split between this service and [libremdb](https://github.com/zyachel/libremdb/).
|
||||
If you believe you can help furthering this project in any way(be it maintaining, fixing issues, or adding features), please [get in touch](#contact).
|
||||
Regardless, any type of contribution is always welcome.
|
||||
The development may seem slow as I don't have lots of free time. And whenever I do, it gets split between this service and [LibreIMDb](https://github.com/zyachel/libremdb/).
|
||||
If you believe you can help furthering this project in any way (be it maintaining, fixing issues, or adding features), please [get in touch](#contact).
|
||||
*Regardless, any type of contribution is always welcome.*
|
||||
|
||||
**If you plan on contributing, please read our [CONTRIBUTING.md](./CONTRIBUTING.md) file.**
|
||||
|
||||
|
|
@ -245,7 +249,7 @@ Regardless, any type of contribution is always welcome.
|
|||
|
||||
### Automatic redirection
|
||||
|
||||
Following extensions can be used to automatically redirect Quora URLs to Quetre:
|
||||
The following extensions can be used to automatically redirect Quora URLs to Quetre:
|
||||
|
||||
- [redirector](https://github.com/einaregilsson/Redirector)
|
||||
You can manually add any redirect.
|
||||
|
|
@ -257,7 +261,7 @@ Following extensions can be used to automatically redirect Quora URLs to Quetre:
|
|||
Include pattern: (https:\/\/.{2,}\.quora\.com\/.*)
|
||||
Redirect to: https://quetre.iket.me/redirect/$1
|
||||
Pattern type: Regular Expression
|
||||
Pattern description: redirects all Quora urls to Quetre
|
||||
Pattern description: Redirects all Quora urls to Quetre
|
||||
```
|
||||
|
||||
This config should output:
|
||||
|
|
@ -284,7 +288,7 @@ Following extensions can be used to automatically redirect Quora URLs to Quetre:
|
|||
|
||||
### Programming
|
||||
|
||||
- [JavaScript](https://www.ecma-international.org/technical-committees/tc39/): programming language
|
||||
- [JavaScript](https://www.ecma-international.org/technical-committees/tc39/): Programming language
|
||||
- [Sass](https://sass-lang.com/): CSS preprocessor
|
||||
- [Pug](https://pugjs.org/): Template engine
|
||||
- [Node.js](https://nodejs.org/en/): JS runtime environment
|
||||
|
|
@ -322,4 +326,4 @@ Send a message on [\[matrix\]](https://matrix.to/#/@ninal:matrix.org) or go old
|
|||
|
||||
## License
|
||||
|
||||
Licensed under [GNU AGPLv3](./LICENSE).
|
||||
Licensed under [GNU AGPLv3](./LICENSE).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue