erin
/
ferret
1
1
Fork 0
Code Issues 8 Pull Requests Packages Projects Releases Wiki Activity

whoops

main
~erin 2023-07-25 23:19:23 -04:00
parent 512632d042
commit 09b56b5096
Signed by: erin
GPG Key ID: 0FEDEAFF1C14847E
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -20,16 +20,14 @@
5. Install the [just](https://just.systems/) command runner
### Parts
The [crawler](/crawler) is a self-contained executable, that when ran crawls through the URLs and inserts them into an **SQL** database.
The engine [core](/core) is a server that hosts an *API* to perform search queries on the database.
The `crawler` is a self-contained executable, that when ran crawls through the URLs and inserts them into an **SQL** database.
The engine `core` is a server that hosts an *API* to perform search queries on the database.
It creates a seperate indexed table in the database, and has a search endpoint at `/api/search`.
It takes a `POST` request with a *JSON* body, and returns a *JSON* response.
The variables it takes are:
- `language`: an *ISO 639-3* lang code
- `include`: the primary search query
- `ignore`: keywords to ignore (optional)
- `option`: a `SearchType` (`Fuzzy`, `Regex`, `Sql`)
- `language`: an *ISO 639-3* lang code
- `include`: the primary search query
- `ignore`: keywords to ignore (optional)
- `option`: a `SearchType` (`Fuzzy`, `Regex`, `Sql`)