lucadibello / beer-search-engine Goto Github PK

Website URL: https://www.brewerydb.com/brewknowledge

Package:

https://www.npmjs.com/package/eslint-plugin-unused-imports

Website URL: https://beerme.com/beerlist.php

Website URL: https://www.ratebeer.com/

Since this website loads content dynamically, their GraphQL API will be used!

(Scrapy documentation here!)

Add additional pages to the website.

Some ideas:

• Top 50 beers page
• Worst 50 beers page
• Beers near me (based on location)

Create set of Scrapy spiders to extract beer data:

1. #4
2. #3
3. #2

Show search results as snippets (2-3 lines of text with highlighted keywords, google-like)

Useful links:

• System Usability Scale
• User Experience Questionnaire
  • English version
  • Italian version

The beerme.com crawler does not follow the chosen standard format, and a lot of information is simply missing (even though it is clearly available on the website...). Also, the information you are crawling is wrong: now you are crawling brewery information, not beers.

@Enrico-Benedettini you must follow this exact format (are TS typings but I hope you will understand):

type Brewer = {
  name: string | null
  city: string | null
  country: {
    code: string | null
    name: string | null
  }
  state: {
    name: string | null
  }
}

type CriticScore = {
  max: number
  actual: number
}

type BeerPrice = {
  amount: number
  currency: string
}

interface Beer {
  docno: string
  name: string
  description: string
  image_url: string
  price: BeerPrice | null
  style: null | string
  critic_score: CriticScore
  brewer: Brewer
  alcohol_bv: number
  tasting_notes: null | string
  closure: null | string
  packaging: null | string
}

Todo list:

• Add clickable search button in QueryInput component
• Fix result snippet image when on smartphone
• Implement Details button to display missing data
• Highlight text in whole result snippet (not only in description)
• Add warning message when no documents are available
• Show spinner when images are loading
• Fix homepage example queries
• Add dynamic filters (name, abv, rating)
• Add screen reader support + enhanced overall accessibility

Create APIs to be able to interact with the PyTerrier document index.

• NextJS latest v14 with app router and turbopack!
• Runtime & Package mangaer: Bun (let's test it)

Dependencies:

• TailwindCSS
• Stale-While-Revalidate (to discuss)

Notice:

Please, remember to use bun commands when working with the project!

• Run project lifecycle functions: bun dev / bun build / ...
• Install new packages: bun install ... / bun install -d ...

• Creating the index out of the data.json

Simple features to implement:

• #14

Complex features to implemenet:

• #17

Website URL: https://winevybe.com