Skip to content

nronzel/pathfindr

Repository files navigation

Pathfindr

Pathfindr helps you analyze linking within your website by generating a comprehensive report on internal and external links.

Features

  • Crawls a given base URL to enumerate all links.
  • Ignores pages with Content-Type other than text/html.
  • Uses concurrent crawling for improved performance.
  • Logs results to CSV file

Quick Start

Installation

Clone the repository:

git clone https://github.com/nronzel/pathfindr.git

Navigate to the project directory:

cd pathfindr

Install the required dependencies:

npm install

Usage

Run Pathfindr by providing the base URL you wish to crawl. This URL serves as both the starting point and scope limiter for the crawl.

npm start https://url-to-crawl.com

A report will be printed to your console upon completion.

Tests

To run the available unit tests:

npm test

Future Roadmap

  • Enhance error handling to accommodate larger, more complex sites.
  • Include external link counts in report. done
  • Add CSV export functionality. done
  • Implement logging for comprehensive crawling records.
  • Incorporate data visualization to represent internal linking graphically.

About

Crawls a website and generates a report on it's internal and external linking

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published