Otter

An easy-to-use search engine/API for all Hack Club projects, built with Rust, Svelte and Postgres. Projects are ingested from the Ships API and Airbridge, and are then indexed and stored in the database.

API Documentation

Documentation for the API can be found at https://otter.shymike.dev/docs! (or http://localhost:3000/docs when running locally)

Development

Make sure you have Docker, Rust and Bun installed.

# Start Postgres and Redis
docker compose up -d

# Start the backend
cd app
cargo run

# Start the frontend
cd frontend
bun i
bun dev

These should now be live:

• frontend: http://localhost:5173
• backend: http://localhost:3000

Star History