40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
# Goeievraagle
|
|
Search engine made for the "Zoekmachines" course at the University of Amsterdam,
|
|
taught by dr. Maarten Marx.
|
|
|
|
## Requirements
|
|
|
|
- Docker and docker-compose (Used for easy setup of Elasticsearch).
|
|
- Python 3.7 or higher.
|
|
- `pip` for installing Python packages.
|
|
- `yarn` for installing JavaScript libraries.
|
|
|
|
## Set-up
|
|
|
|
### Elasticsearch
|
|
- Run `docker-compose up -d` in the root folder to start Elasticsearch.
|
|
|
|
### Backend
|
|
- `cd` to the `backend` folder.
|
|
- Create a virtualenv: `virtualenv venv -p python3.7`.
|
|
- Activate the virtualenv: `. venv/bin/activate`.
|
|
- Install required packages: `pip install -r requirements.txt`.
|
|
- Import the data set: `flask import-data ../data/{questions,categories}.csv`.
|
|
- Run the development server: `flask run`.
|
|
|
|
### Frontend
|
|
- Open a new terminnal
|
|
- `cd` to the `frontend` folder.
|
|
- Install required packages: `yarn install`.
|
|
- Run the development server: `yarn dev`.
|
|
|
|
Now, go to http://localhost:8080/ in your browser.
|
|
|
|
## Disclaimer
|
|
Goeievraagle parodizes the logo, makes use of several styling elements and overall
|
|
simply rips off the Google search engine. Note that I have no interest in further
|
|
develop Goeievraagle.
|
|
|
|
I will take down this repository without further ado if Alphabet Inc. or Google
|
|
LLC finds Goeievraagle to infringe their legal rights.
|