whoops
parent
512632d042
commit
09b56b5096
14
README.md
14
README.md
|
@ -20,16 +20,14 @@
|
||||||
5. Install the [just](https://just.systems/) command runner
|
5. Install the [just](https://just.systems/) command runner
|
||||||
|
|
||||||
### Parts
|
### Parts
|
||||||
The [crawler](/crawler) is a self-contained executable, that when ran crawls through the URLs and inserts them into an **SQL** 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](/core) is a server that hosts an *API* to perform search queries on the 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 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.
|
It takes a `POST` request with a *JSON* body, and returns a *JSON* response.
|
||||||
|
|
||||||
The variables it takes are:
|
The variables it takes are:
|
||||||
- `language`: an *ISO 639-3* lang code
|
- `language`: an *ISO 639-3* lang code
|
||||||
- `include`: the primary search query
|
- `include`: the primary search query
|
||||||
- `ignore`: keywords to ignore (optional)
|
- `ignore`: keywords to ignore (optional)
|
||||||
- `option`: a `SearchType` (`Fuzzy`, `Regex`, `Sql`)
|
- `option`: a `SearchType` (`Fuzzy`, `Regex`, `Sql`)
|
||||||
|
|
Loading…
Reference in New Issue