websurfx/README.org

#+html: <h1 align="center">Websurfx</h1> 
#+html: <p align="center">
#+html: <i> A lightning-fast, privacy-respecting, secure <a href="https://en.wikipedia.org/wiki/Metasearch_engine">meta search engine</a> (pronounced as websurface or web-surface /wɛbˈsɜːrfəs/.) written in Rust. It provides a fast and secure search experience while respecting user privacy.</i>
#+html: <br/>
#+html: <br/>
#+html: <b align="center"><a href="README.org">Readme</a></b> | <b><a href="https://discord.gg/k4GH2TnZ">Discord</a></b> | <b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b>
#+html: <br/><br/>
#+html: <!---add status badges here----> 
#+html: </p>

* Table of Contents

- [[#features][Features]]
- [[#preview][Preview]]
  - [[#main-page][Main Page]]
  - [[#search-page][Search Page]]
  - [[#404-error-page][404 Error Page]]
- [[#installation-and-testing][Installation and Testing]]
- [[#more-contributers-wanted][More Contributers Wanted]]
- [[#faq-frequently-asked-questions][FAQ - (Frequently Asked Questions)]]
  - [[#why-websurfx][Why Websurfx?]]
  - [[#why-agplv3][Why AGPLv3?]]
  - [[#why-rust][Why Rust?]]
- [[#contributing][Contributing]]
  - [[#not-a-developer-but-still-want-to-contribute][Not a developer but still want to contribute]]
  - [[#developer][Developer]]
- [[#license][License]]
- [[#credits][Credits]]

* Features

- Proper NSFW blocking
- High level customizability with 9 colorchemes provided by default with a simple theme, also supporting creation of your custom themes and colorschemes very quickly and easily
- Advanced image search
- Fast, private and secure
- 100% free and open source
- and lots more...

* Preview

** Main Page

#+html: <img align="center" src="./images/main_page.png" />

** Search Page

#+html: <img align="center" src="./images/search_page.png" />

** 404 Error Page

#+html: <img align="center" src="./images/404_error_page.png" />

* Installation and Testing

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

If you want to use the rolling/edge branch, run the following commands instead:

#+begin_src shell
  git clone https://github.com/neon-mmd/websurfx.git
  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.

* Configuration

Websurfx is configured throught the config.lua file, located at =websurfx/config.lua=.

* Theming

Websurfx comes with several themes and colorschemes by default which you can apply and edit through the config file. Support for custom themes and colorschemes using css and develop your own unique-looking website.

* 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 [[https://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.

* FAQ (Frequently Asked Questions)

** Why Websurfx?

The main goal of the Websurfx project is to provide a fast, secure, and privacy-focused [[https://en.wikipedia.org/wiki/Metasearch_engine][meta search engine]]. While there are many meta search engines available, they do not always guarantee the security of their search engine, which is essential for ensuring privacy. For example, memory vulnerabilities can leak private or sensitive information, which is never good. Websurfx is written in Rust, which guarantees memory safety and eliminates such problems. Many meta search engines also lack key features such as advanced image search, which is required by many graphic designers, content creators, and others. Websurfx aims to provide these features and others, such as proper NSFW blocking, to improve the user experience.

** Why AGPLv3?

Websurfx is released under the *AGPLv3* license to ensure that the source code remains open and transparent. This helps to prevent the inclusion of spyware, telemetry, or other malicious code in the project. *AGPLv3* is a strong copyleft license that ensures the source code of the software remains open and available to everyone, including any modifications or improvements made to the code.

** Why Rust?

Rust was chosen as the programming language for Websurfx due to its memory safety features, which can help prevent vulnerabilities and make the codebase more secure. Rust is also faster than C++, which helps to make Websurfx fast and responsive. In addition, Rust's ownership and borrowing system allows for safe concurrency and thread safety in the codebase.

* Contributing

Contributions are welcome from anyone. It doesn't matter who you are; you can still contribute to the project in your way.

** Not a developer but still want to contribute?

Check out this [[https://youtu.be/FccdqCucVSI][video]] by Mr. Nick on how to contribute.

** Developer

If you are a developer, have a look at the [[file:CONTRIBUTING.org][CONTRIBUTING.org]] document for more information.

* License

Websurfx is available under the [[file:LICENSE][AGPLv3]] license.

* Credits

We would like to thank the following people for their contributions and support:

#+html: <a href="https://github.com/neon-mmd/websurfx/graphs/contributors">
#+html:   <img src="https://contrib.rocks/image?repo=neon-mmd/websurfx" />
#+html: </a>

#+html: <p align="center">
#+html: <a href="https://github.com/neon-mmd/websurfx">
#+html: <img src="https://github.githubassets.com/images/icons/emoji/octocat.png" />
#+html: </a>
#+html: <br><br>
#+html: <i>Thank you for Visiting</i>
#+html: </p>