README.md

OBS.: O README.md foi editado além do prazo para acréscimo do link do vídeo II com correção do volume do áudio. Os dois vídeos estão presentes na descrição do projeto abaixo, mas recomendamos fortemente que assista a versão com áudio melhorado, com mesmo conteúdo da versão anterior - nenhum outro arquivo foi editado além do prazo (vide histórico de commits).

book-finder

Search engine and information retrieval tool for books

Group

• Amanda Soares de Castro Moraes
• Luís Eduardo Martins Alves
• Tales Tomaz Alves

Milestones

• Crawler
• Classifier
• Wrapper
• Crawled data
• Extracted data
• Slides I
• Video I
• Inverted Index
• Query module code
• Query response composition app
• Slides II
• Video II FIXED AUDIO - watch this one
• Video II

Search Engine App Demo

Access the demo video here.

Dev environment and code execution

Commands to run the search engine app:

Using Docker

Build image:

docker build -t book-finder .

Start container:

docker run -p <port>:<port> -e PORT=<port> book-finder # e.g. port = 5000

Access localhost:<port> in your web browser.

Using Python Environment

# Create Python venv
python -m venv .venv

# Activate venv
# Windows
.venv\Scripts\activate
# Linux
source .venv/bin/activate

# Install dependencies and local package
pip install -r requirements

pip install -e .

To run the Book Finder app and test it locally with your own queries do:

cd search_engine
cd gui
flask run

If you wish to run the app on debug mode, run the command below instead of flask run:

python index.py