search

neon-mmd / websurfx

:rocket: An open source alternative to searx which provides a modern-looking :sparkles:, lightning-fast :zap:, privacy respecting :disguised_face:, secure :lock: meta search engine
https://github.com/neon-mmd/websurfx/tree/rolling/docs
GNU Affero General Public License v3.0
721 stars 94 forks source link

✨ `Brave` for the search engine #319

Closed neon-mmd closed 11 months ago

neon-mmd commented 12 months ago

Provide the Brave search engine for the websurfx search engine. To start working on this issue, you will need to create a new file with the name of the desired engine in the folder src/engines/ which is located under the codebase (websurfx directory). Then in the file, just create a new struct with the name of the engine and then create two impl blocks for the struct. One for implementing the SearchEngine trait on it and the other for implementing the parsers to be used for aggregating results.

After that, just put the name of the desired engine in the match statement located here, make sure that the name of engine is in lowercase.

After that, just move to the config file which is located at websurfx/ directory under the code base and then just edit the config file by including the name of the search engine here.

Note The engine name to be included in the config file is not case sensitive but we would still recommend naming it with the camelcase naming convention.

After doing all the fore-mentioned steps, then we would suggest doing a thorough test to make sure everything works as intended and then submitting a PR.

github-actions[bot] commented 12 months ago

The issue has been unlocked and is now ready for dev. If you would like to work on this issue, you can comment to have it assigned to you. You can learn more in our contributing guide https://github.com/neon-mmd/websurfx/blob/rolling/CONTRIBUTING.md

JanKaczmarkiewicz commented 12 months ago

I can work on that.

neon-mmd commented 12 months ago

I can work on that.

Yes, sure :slightly_smiling_face: , I will assign this issue to you right away :rocket: .