Getting Started

This is instructions on setting up this project locally. To get a local copy up, follow these simple example steps.

Prerequisites

Python3

Installation

1. Clone the repo

   git clone https://github.com/CSD301AI16/LinkTraverser.git

2. Install all required package

   cd LinkTraverser
   pip install -r requirements.txt

Run the project

1. Change to this project folder

   After cloning the repo, type this to open the code:

   code .

2. Run the project

   Again, type this in cmd or Terminal

   python runner.py

App description

Read carefully to know more about this app

App template

How to use this app

1. Find a link you want to crawl
2. Type that link in "Input URL" entry
3. Use either slider or type maximum number to crawl
4. Start crawling by clicking "Crawl web" button
5. If you want to rank these URLs, click "Ranking URLs" button
6. The final button is used to export these URLs to html file

(back to top)