qscrape (Q-Scrape)

Note: THIS project is still under development. Please do not use it in production.

What is it for?

With qscrape, you can explore the Web easily. This scraper will continuously fetch resources from the Web. Playing with the console program is the only thing you need to do.

We've provided a command line tool and a library for you, which are simple to use. You can obtain qscrape from NPM. Please see the section How to Obtain.

Try Our Demo

• [(WIP)]

How to Obtain

qscrape provides an NPM package. You can install it with your favorite package managers, and execute it from the command line.

| Package Manager | Command | Shorthand | | ----------------------------- | ------------------------------- | ------------------------- | | bun | bun install --global qscrape | bun i -g qscrape | | npm | npm install --global qscrape | npm i -g qscrape | | pnpm | pnpm install --global qscrape | pnpm i -g qscrape | | yarn | yarn global add qscrape | yarn global add qscrape |

Let's Learn How to Use It

• Run the following command to start:

  qscrape

• Import the library to integrate it in your project:

  import { QScrape } from 'qscrape';

• [Guide (WIP)]

Let's Setup the Project

Note: THIS section is for contributors and developers only

Recommended IDE Setup for You

• IDEs:
  • VSCode
• Extensions:
  • Prettier for VSCode

See What Dependencies We Are Using

• Builders
  • Vite
• Environments
  • Node.js v20
• Libraries
  • Chalk
  • External Editor
  • Inquirer.js
  • JSDOM
  • Ora
• Linters
  • Prettier
  • TypeScript
• Testing
  • Vitest

See What Commands We Are Using

| Package Manager | Command | Script | Description | | ---------------- | --------- | ----------- | --------------------------------------------- | | bun / (p)npm | install | | Install dependencies | | bun / (p)npm | run | build | Build the project for production | | bun / (p)npm | run | check | Check the codes with TypeScript | | bun / (p)npm | run | dev | Build and execute the project for development | | bun / (p)npm | run | dev-build | Build the project for development | | bun / (p)npm | run | dev-test | Run tests in watch mode | | bun / (p)npm | run | format | Format codes using Prettier | | bun / (p)npm | run | exec | Execute the built program | | bun / (p)npm | run | start | Build and execute the project for production | | bun / (p)npm | run | test | Run tests |

Be Aware of These Details

You may encounter some problems during development and deployment. Please read the following notes carefully.

1. (WIP)