https://github.com/tvanhens/pathery

Serverless search for AWS.
https://github.com/tvanhens/pathery

aws aws-lambda rust serverless tantivy

Last synced: about 1 month ago
JSON representation

Serverless search for AWS.

• Host: GitHub
• URL: https://github.com/tvanhens/pathery
• Owner: tvanhens
• License: mit
• Created: 2022-11-11T23:40:41.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-18T23:51:49.000Z (over 1 year ago)
• Last Synced: 2024-07-11T15:39:58.217Z (2 months ago)
• Topics: aws, aws-lambda, rust, serverless, tantivy
• Language: Rust
• Homepage:
• Size: 501 KB
• Stars: 74
• Watchers: 4
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pathery :fire: Serverless Search :fire:

[![npm version](https://badge.fury.io/js/@pathery%2Fcdk.svg)](https://badge.fury.io/js/@pathery%2Fcdk)

Pathery is a **serverless search service** built on AWS using Rust, CDK and [Tantivy][tantivy]. It uses AWS managed serverless offerings – DynamoDB, EFS, Lambda, SQS, and API Gateway – to the maximum extent possible.

**:bell: WARNING:** This is currently a work in progress and not ready for production usage.

## Features

- **🔥 Fast full-text search**. Built on Rust to limit AWS Lambda cold start overhead.

- **🥰 Simple REST API**. A [simple REST API][api-docs] to make search as easy as possible.

- **👍 Easy to install**. Ships as a CDK Component, making it easy to [get started][get-started].

- **💵 Usage based infra**. No long running servers, only pay for what you use.

- **🔼 Built for AWS**. Leans on AWS managed services to limit maintenance burden and maximize scalability.

  - Document store: [DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html)

  - Index store: [Elastic File System (EFS)](https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html)

  - Index writer & handler: [Lambda](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html)

  - Index queue: [SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html)

  - API: [API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html)

## Getting Started

Check out the [getting started guide][get-started] to deploy Pathery into your AWS account using CDK.

[tantivy]: https://github.com/quickwit-oss/tantivy

[get-started]: ./examples/getting-started/

[api-docs]: ./doc/api.md

## Architecture

Follow along with the Dev Log:

- [Pathery Dev Log #1: Performant Serverless Queries Without a Cluster](https://tvanhens.substack.com/p/pathery-dev-log-1-performant-serverless)

- [Pathery Dev Log #2: Indexing and the Document Store](https://tvanhens.substack.com/p/pathery-dev-log-2-indexing-and-the)

![diagram](/doc/diagram.png)