alamin/websurfx
alamin/websurfx
0
0
Fork 0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-11-21 13:38:21 -05:00
Code Issues Releases Activity

updated installations steps and moved goals to project dashboard

Browse Source
This commit is contained in:
neon_arch 2023-05-02 12:08:50 +03:00
parent c170de8194
commit b21c96a1dd
2 changed files with 9 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.org
View File

@ -18,12 +18,13 @@ Websurfx is a lightning-fast, privacy-respecting, secure [[https://en.wikipedia.
* Installation and Testing
To get started with Websurfx, clone the repository, edit the config file which is located in the =websurfx= directory and run it using the following commands:
To get started with Websurfx, clone the repository, edit the config file which is located in the =websurfx= directory and install redis server by following the instructions located [[https://redis.io/docs/getting-started/][here]] and then run the websurfx server and redis server using the following commands:
#+begin_src shell
git clone https://github.com/neon-mmd/websurfx.git
cd websurfx
cargo build
redis-server -p 8082 &
./target/debug/websurfx
#+end_src
@ -34,16 +35,21 @@ If you want to use the rolling/edge branch, run the following commands instead:
cd websurfx
git checkout rolling
cargo build
redis-server -p 8082 &
./target/debug/websurfx
#+end_src
Once you have started the server, open your preferred web browser and navigate to http://127.0.0.1:8080 to start using Websurfx.
*Important Note:* Please be aware that the project is still in the testing phase and is not ready for production use. Do not refresh the page excessively or make too many requests, as this could result in IP blocking.
*Important Note:* Please be aware that the project is still in the testing phase and is not ready for production use.
* More Contributers Wanted
We are looking for more willing contributors to help grow this project. For more information on how you can contribute, check out the [[file:goals.org][goals.org]] file and the [[file:CONTRIBUTING.org][CONTRIBUTING.org]] file for guidelines and rules for making contributions.
We are looking for more willing contributors to help grow this project. For more information on how you can contribute, check out the [[file:goals.orhttps://github.com/neon-mmd/websurfx/projects?query=is%3Aopen][project board]] and the [[file:CONTRIBUTING.org][CONTRIBUTING.org]] file for guidelines and rules for making contributions.
* Testers Wanted
We are looking for willing testers to test whether the code to evade IP blocking works and is resillient enough to prevent IP blocks and banning by the upstream servers.
* FAQ (Frequently Asked Questions)

36
goals.org
View File

@ -1,39 +1,3 @@
* TODO Goals for v0.1.0
- [ ] Add unit tests, integration test, and doc tests to the project source code.
- [ ] Add code to remove NSFW content from search results using a blocklist.
- [ ] Add code to disallow user from searching for sensitive content (similar functionality to swisscows search engine) if strict safe search is turned on.
- [ ] Improve error handling to handle scraping errors, reqwest errors, and other issues.
- [ ] Implement random delays and behaviors to emulate human behavior to evade IP blocking.
- [ ] Create a settings page to allow users to configure the search engine and save their preferences using cookies.
- [ ] Add a search engine logo to the index page and the navbar.
- [X] Add Python/Lua configuration options to give more control to the user (server maintainer/administrator).
- [X] Add the ability for users to change the colorscheme of the page. =For example:== If a simple theme is used, then there should be the option of 9 different colorschemes to choose from, such as Catppuccino-Mocha, Solarized Dark, Nord, etc.
- [X] Write a rust.yml file for automated testing of the project.
- [X] Improve documentation for the project source code.
- [X] Add a FAQ section to the README.org file to answer common questions about the project.
- [X] Add logging to the websurfx project.
- [X] Generate random user agents to protect user privacy.
- [X] Add DuckDuckGo and at least one Searx engine instance as upstream providers.
- [X] Add pagination support for search results.
- [X] Create basic Handlebars pages and theme with Catppuccino colorscheme.
* Goals for future development
- Replace Handlebars with the faster templating engine /Tera/.