npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@umarkhan9166/webcrawler

v1.0.2

Published

A CLI web crawler written in TypeScript

Downloads

6

Readme

@umarkhan9166/webcrawler

Overview

@umarkhan9166/webcrawler is a simple CLI web crawler written in TypeScript. It takes a website URL as input, crawls the website, and generates a report of links along with their occurrence counts.

Setup

To set up the project locally, follow these steps:

Clone the repository:

git clone https://github.com/UmarKhan19/webcrawler.git
cd webcrawler

Install dependencies:

npm install

Building TypeScript Files. Compile the TypeScript files into JavaScript using the following command:

npm run build

This command will transpile. TypeScript files from the src directory into the dist directory.

Running the Web Crawler. To run the web crawler, use the following command:

npm start <website-url>

Replace <website-url> with the URL of the website you want to crawl.

Project Structure

  • index.ts: The entry point of the CLI, parsing command-line arguments and initiating the crawling process.
  • crawl.ts: Contains functions for crawling pages, normalizing URLs, and extracting URLs from HTML content.
  • report.ts: Provides functions for sorting and printing the crawled data.

Run as npm package

To run webcrawler as npm package you can install it globally.

npm i -g @umarkhan9166/webcrawler

Example Usage

webcrawler https://example.com

This will initiate the crawler on the specified website and output a report detailing the links and their occurrence counts.

Notes

  • Ensure you have Node.js and npm installed on your machine.
  • The crawler uses the jsdom library for HTML parsing and manipulation.
  • Please note that this is a simple CLI tool and might not handle all edge cases or complex websites.
  • Feel free to explore and modify the code as needed for your specific use case. Happy crawling!

Issues and Contributions

If you encounter any issues or have suggestions for improvements, please open an issue on GitHub.

License

This project is licensed under the ISC License - see the LICENSE file for details.