ferret/README.md

21 lines
690 B
Markdown

# Ferret
**Ferret** is an attempt at a new, self-hosted, independent search engine.
## Goals
- Simple and accessible pure-HTML user interface
- No tracking or bloat
- Only indexes smaller actually cool sites
## Technology
- Written in **Rust**
- Uses the [Tokio](https://tokio.rs/) async framwework
- Uses [Axum](https://lib.rs/crates/axum) as a web framework
- [SQLx](https://lib.rs/crates/sqlx) compile-time checked SQL queries
## Development
1. Install **Rust** via `rustup`
2. Clone this repository
3. Install [sqlx-cli](https://lib.rs/crates/sqlx-cli)
4. Set the `DATABASE_URL` environment variable to `"sqlite:todos.db"`
5. Install the [just](https://just.systems/) command runner