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

marking goals/tasks as complete and updating installation instructions

Browse Source
This commit is contained in:
neon_arch 2023-04-30 20:13:03 +03:00
parent 71fae8b496
commit f8c3c8dcbe
2 changed files with 7 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.org
View File

@ -18,13 +18,13 @@ Websurfx is a lightning-fast, privacy-respecting, secure [[https://en.wikipedia.
* Installation and Testing
To get started with Websurfx, clone the repository 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 run it using the following commands:
#+begin_src shell
git clone https://github.com/neon-mmd/websurfx.git
cd websurfx
cargo build
./target/debug/websurfx --port 8080
./target/debug/websurfx
#+end_src
If you want to use the rolling/edge branch, run the following commands instead:
@ -34,7 +34,7 @@ If you want to use the rolling/edge branch, run the following commands instead:
cd websurfx
git checkout rolling
cargo build
./target/debug/websurfx --port 8080
./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.

12
goals.org
View File

@ -8,20 +8,16 @@
- [ ] Improve error handling to handle scraping errors, reqwest errors, and other issues.
- [ ] 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.
- [ ] Implement random delays and behaviors to emulate human behavior to evade IP blocking.
- [ ] Add Python/Lua configuration options to give more control to the user (server maintainer/administrator).
- [ ] 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.