https://github.com/thewrlck/quotz

A Node.js application demonstrating the use of Puppeteer and Orama SDK to create a quote database and search API.
https://github.com/thewrlck/quotz

expressjs orama puppeteer typescript

Last synced: about 17 hours ago
JSON representation

A Node.js application demonstrating the use of Puppeteer and Orama SDK to create a quote database and search API.

• Host: GitHub
• URL: https://github.com/thewrlck/quotz
• Owner: thewrlck
• Created: 2024-08-19T06:57:30.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-19T09:43:28.000Z (3 months ago)
• Last Synced: 2024-10-17T22:27:21.332Z (19 days ago)
• Topics: expressjs, orama, puppeteer, typescript
• Language: TypeScript
• Homepage: https://askorama.ai/
• Size: 122 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# quotz

A Node.js application demonstrating the use of Puppeteer and [Orama SDK](https://askorama.ai/) to create a quote database and search API.

## Features

**Quote Scraping**: Use Puppeteer to gather 100 famous quotes from a specified website, iterating through multiple pages.

**Data Enrichment**: Utilizes Orama SDK to save metadata and scraped quotes.

## API

- `/quotes`: Save a list of 100 scraped enriched quotes.

- `/search`: Enables searching for specific terms within the quote dataset using Orama's search capabilities.

## Getting Started

Install dependencies: `npm install`

Build packages: `npm run build`

Run the API: `npm run api`

Run with Chrome browser: `http://localhost:3000/quotes`

Try to search by author or text:

- `http://localhost:3000/search?q=Albert`

- `http://localhost:3000/search?q=Jk+Rowling`

- `http://localhost:3000/search?q=thinking`

Note: This project is primarily intended as a learning exercise for Orama SDK and is subject to future enhancements.

## Potential Improvements

- Implementation of various search types

- Development of a user-friendly interface

- Expansion of the quote dataset with user inputs

- Optimization of scraping and data processing

By clearly outlining the project's purpose, features, and potential future directions, this description provides a comprehensive overview for potential users and contributors.