MD AL AMIN TALUKDAR commited on
Commit
8f6bf5d
1 Parent(s): f2d1865

docs: Refactor project goals for clarity

Browse files

This commit refactors the project goals for clarity, improving the readability and ensuring that the goals are accurately represented. We have made some changes to the wording to improve grammar and phrasing, but the goals themselves remain the same.

Files changed (1) hide show
  1. goals.org +26 -28
goals.org CHANGED
@@ -1,57 +1,55 @@
1
  * TODO Goals for v0.1.0
2
 
3
- - [ ] Add unit tests, integration test, doc tests in the project source code.
4
 
5
- - [ ] Add code to remove nsfw content from search results using a blocklist.
6
 
7
- - [ ] Add code to disallow user to search sensitive content (similar functionality to swisscows search engine) if strict safe search is turned on.
8
 
9
- - [ ] Add better error handling code to handle scraping error, reqwest error, etc.
10
 
11
- - [ ] Add ability to change colorschemes with the theme style of the page.
12
 
13
  =For example:=
14
 
15
- If there is simple theme is there then there is option of 9 different colorschemes to choose from such as catppuccin-mocha, solarized dark, nord, etc.
16
 
17
- - [ ] Add random delays and behaviours to emulate human behaviour if needed to evade ip blocking.
18
 
19
- - [ ] Add python/lua config to the search engine and also ensuring and giving more control to the user (server maintainer/administrator).
20
 
21
- - [ ] Add settings page to configure search engine on the fly by the user and save his preferences using cookies.
22
 
23
- - [ ] Add search engine logo to index page and to the navbar (on the right hand side).
24
 
25
- - [X] Write rust.yml for automating testing of the project.
26
 
27
- - [X] Add better documentation to source code.
28
 
29
- - [X] Add FAQ section in readme.org for answering commonly asked questions like why websurfx?, why rust?, why GPLv3?, etc.
30
 
31
- - [X] Add logging to websurfx project.
32
 
33
- - [X] Add code to generate random user agent to protect user's privacy.
34
 
35
- - [X] Add duckduckgo engine as an upstream.
36
 
37
- - [X] Add atleast one searx engine instance as an upstream engine.
38
 
39
- - [X] Add pagination support.
40
-
41
- - [X] Add basic handlebars pages and theme with catppuccin colorscheme.
42
 
43
- * Goals for the future
44
 
45
- - Move from handlebars to faster templating engine /Tera/.
46
 
47
- - Adding more upstream search engines.
48
 
49
- - Add dorking support (like google).
50
 
51
- - Add advanced search functionality and dropdown menu for it.
52
 
53
- - Add more categories to search engine's search page like images, files, all, news, maps, etc.
54
 
55
- - Add advanced image functionality to images category (which will be a great aid for content creators, video editors, etc.).
56
 
57
- - Add GPT integration (taking insipiration from langchain module of python or incorporating it using pyo3) and give user the choice to add api key (giving user the choice is important as there are many people who are against ai and so this will ensure that those people also get satisfied like if they don't gpt so they will not their api key and so it will be disabled).
 
1
  * TODO Goals for v0.1.0
2
 
3
+ - [ ] Add unit tests, integration test, and doc tests to the project source code.
4
 
5
+ - [ ] Add code to remove NSFW content from search results using a blocklist.
6
 
7
+ - [ ] Add code to disallow user from searching for sensitive content (similar functionality to swisscows search engine) if strict safe search is turned on.
8
 
9
+ - [ ] Improve error handling to handle scraping errors, reqwest errors, and other issues.
10
 
11
+ - [ ] Add the ability for users to change the colorscheme of the page.
12
 
13
  =For example:=
14
 
15
+ 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.
16
 
17
+ - [ ] Implement random delays and behaviors to emulate human behavior to evade IP blocking.
18
 
19
+ - [ ] Add Python/Lua configuration options to give more control to the user (server maintainer/administrator).
20
 
21
+ - [ ] Create a settings page to allow users to configure the search engine and save their preferences using cookies.
22
 
23
+ - [ ] Add a search engine logo to the index page and the navbar.
24
 
25
+ - [X] Write a rust.yml file for automated testing of the project.
26
 
27
+ - [X] Improve documentation for the project source code.
28
 
29
+ - [X] Add a FAQ section to the README.org file to answer common questions about the project.
30
 
31
+ - [X] Add logging to the websurfx project.
32
 
33
+ - [X] Generate random user agents to protect user privacy.
34
 
35
+ - [X] Add DuckDuckGo and at least one Searx engine instance as upstream providers.
36
 
37
+ - [X] Add pagination support for search results.
38
 
39
+ - [X] Create basic Handlebars pages and theme with Catppuccino colorscheme.
 
 
40
 
41
+ * Goals for future development
42
 
43
+ - Replace Handlebars with the faster templating engine /Tera/.
44
 
45
+ - Add more upstream search engines.
46
 
47
+ - Implement dorking support (like Google).
48
 
49
+ - Add advanced search functionality and a dropdown menu for it.
50
 
51
+ - Add more categories to the search engine's search page, such as images, files, news, and maps.
52
 
53
+ - Add advanced image functionality for content creators, video editors, etc.
54
 
55
+ - Add GPT integration, taking inspiration from the Langchain module of Python or incorporating it using pyo3, and give users the choice to add an API key. Giving users the choice is important, as some people may be against AI, and this will ensure that those users who don't want to use GPT can disable it by not adding an API key.