alamin/websurfx
alamin/websurfx
0
0
Fork 0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-12-26 22:38:22 -05:00
Code Issues Releases Activity
Mirror of the Websurfx project https://github.com/neon-mmd/websurfx
8 Commits 3 Branches 283 Tags 12 MiB
Rust 81.7%
CSS 9.7%
JavaScript 4.6%
Lua 1.8%
Dockerfile 1.3%
Other 0.9%
5e1122bc9f
Go to file
neon_arch 5e1122bc9f updating README.org for improving installation step
2023-04-25 16:36:58 +03:00
public initial commit 2023-04-22 14:35:07 +03:00
src Refactoring code and separating code into files for better maintainability 2023-04-25 16:30:04 +03:00
.gitignore initial commit 2023-04-22 14:35:07 +03:00
Cargo.lock add logging middleware 2023-04-25 18:57:18 +08:00
Cargo.toml add logging middleware 2023-04-25 18:57:18 +08:00
CONTRIBUTING.org initial commit 2023-04-22 14:35:07 +03:00
goals.org Adding more goals to goals.org and marking completed goals. 2023-04-25 16:34:21 +03:00
LICENSE Add LICENSE 2023-04-22 11:37:39 +00:00
README.org updating README.org for improving installation step 2023-04-25 16:36:58 +03:00

README.org

Websurfx

a lightening fast, privacy respecting, secure meta search engine. (pronounced as websurface or web-surface wɛbˈsɜːrfəs.)

Installation and Testing

To start installing, testing and playing around with search engine. Clone the repo and then cargo run as shown below:

  git clone https://gitlab.com/NEON-MMD/websurfx.git
  cd websurfx
  cargo build
  ./target/debug/websurfx --port <what ever port you want the server to launch on>

and then open your browser of choice and visit http://127.0.0.1:8080 and then you can start playing with it right away.

Important Note: Do not over refresh your page or put too many requests or start hosting on production server as there are no behaviours right now in the code to prevent ip blocking (it is still work under process) and you can potential can get your ip blocked/banned and also the project is still under testing phase and far from being complete and ready to be hosted on production machines.

Contributing

Contributions are welcome. It does not matter who you are you can still contribute to the project in your way :).

Not a developer but still want to contribute

Here is video by Mr. Nick on how to contribute and credit to him as well

Developer

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

License

The project is available under the GPLv3 license.