From 0ebb5f7013d9cad3f9c81600e1a5555d7889d8c7 Mon Sep 17 00:00:00 2001 From: Sijmen Schoon Date: Fri, 19 Oct 2018 10:19:21 +0200 Subject: [PATCH] Add README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8512140 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# 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.