IR24W-A3-G3

Group Members

Ian Dai - idai - 80419415

Xiao Du - xdu7 - 56714415

Henry Wang - penghanw - 85703671

---

For Python code:

Ensure Python is installed

1. Run

cd api

2. Create a virtual environment so that dependencies do not conflict

python -m venv .venv

3. Activate virtual environment

   VS Code may prompt to automatically select the newly created virtual environment. Otherwise, for Mac/Linux, run

   source .venv/bin/activate

   and for Windows, run

   .\.venv\scripts\activate

4. To install dependencies, run

pip install -r requirements.txt

You can now run any python code.

For creating index

Ensure you are in the root directory and that you have the all of the webpages in one folder labeled "DEV" in the indexer folder

Like so:

To start creating the index, run

python indexer\indexer.py

or

python3 indexer\indexer.py

For backend:

1. From root directory

Run

cd api
cd src

2. Run

python main.py

or

python3 main.py

For Frontend:

1. Install Node and npm here.

From root directory

Run

cd front

Run

npm install

Run

npm run dev

A server will start at http://localhost:5173/ (or 127.0.0.1:5173)

Making a query

Open a browser and navigate to http://localhost:5173/ (or 127.0.0.1:5173)

The page should look something like this

Simply enter a query into the search bar at the top and click Search