@crawlee/templates 3.0.4-beta.6 → 3.0.4-beta.9

package/README.md

@@ -6,7 +6,7 @@
         </picture>
     </a>
     <br>
-    <small>The scalable web crawling and scraping library for JavaScript</small>
+    <small>The web scraping and browser automation library</small>
 </h1>
 
 <p align=center>
@@ -16,138 +16,107 @@
     <a href="https://github.com/apify/crawlee/actions/workflows/test-and-release.yml"><img src="https://github.com/apify/crawlee/actions/workflows/test-and-release.yml/badge.svg?branch=master" alt="Build Status" style="max-width: 100%;"></a>
 </p>
 
->👉👉👉 Crawlee is the successor to [Apify SDK](https://sdk.apify.com). 🎉 Fully rewritten in **TypeScript** for a better developer experience, and with even more powerful anti-blocking features. The interface is almost the same as Apify SDK so upgrading is a breeze. Read [the upgrading guide](https://crawlee.dev/docs/upgrading/upgrading-to-v3) to learn about the changes. 👈👈👈
+> ℹ️ Crawlee is the successor to [Apify SDK](https://sdk.apify.com). 🎉 Fully rewritten in **TypeScript** for a better developer experience, and with even more powerful anti-blocking features. The interface is almost the same as Apify SDK so upgrading is a breeze. Read [the upgrading guide](https://crawlee.dev/docs/upgrading/upgrading-to-v3) to learn about the changes. ℹ️
 
-Crawlee simplifies the development of web crawlers, scrapers, data extractors and web automation jobs. It provides tools to manage and automatically scale a pool of headless browsers, to maintain queues of URLs to crawl, store crawling results to a local filesystem or into the cloud, rotate proxies and much more. Crawlee is available as the [`crawlee`](https://www.npmjs.com/package/crawlee) NPM package. It can be used either stand-alone in your own applications or in [actors](https://docs.apify.com/actor) running on the [Apify Cloud](https://apify.com/).
+Crawlee covers your crawling and scraping end-to-end and **helps you build reliable scrapers. Fast.**
 
-**View full documentation, guides and examples on the [Crawlee project website](https://crawlee.dev)**
+Your crawlers will appear human-like and fly under the radar of modern bot protections even with the default configuration. Crawlee gives you the tools to crawl the web for links, scrape data, and store it to disk or cloud while staying configurable to suit your project's needs.
 
-> Would you like to work with us on Crawlee or similar projects? [We are hiring!](https://apify.com/jobs#senior-node.js-engineer)
+Crawlee is available as the [`crawlee`](https://www.npmjs.com/package/crawlee) NPM package.
 
-## Motivation
+> 👉 **View full documentation, guides and examples on the [Crawlee project website](https://crawlee.dev)** 👈
 
-Thanks to tools like [Playwright](https://github.com/microsoft/playwright), [Puppeteer](https://github.com/puppeteer/puppeteer) or [Cheerio](https://www.npmjs.com/package/cheerio), it is easy to write Node.js code to extract data from web pages. But eventually things will get complicated. For example, when you try to:
+## Installation
 
-- Perform a deep crawl of an entire website using a persistent queue of URLs.
-- Run your scraping code on a list of 100k URLs in a CSV file, without losing any data when your code crashes.
-- Rotate proxies to hide your browser origin and keep user-like sessions.
-- Disable browser fingerprinting protections used by websites.
+We recommend visiting the [Introduction tutorial](https://crawlee.dev/docs/introduction) in Crawlee documentation for more information.
 
-Python has [Scrapy](https://scrapy.org/) for these tasks, but there was no such library for **JavaScript, the language of the web**. The use of JavaScript is natural, since the same language is used to write the scripts as well as the data extraction code running in a browser.
+> Crawlee requires **Node.js 16 or higher**.
 
-The goal of Crawlee is to fill this gap and provide a toolbox for generic web scraping, crawling and automation tasks in JavaScript. So don't reinvent the wheel every time you need data from the web, and focus on writing code specific to the target website, rather than developing commonalities.
+### With Crawlee CLI
 
-## Overview
+The fastest way to try Crawlee out is to use the **Crawlee CLI** and choose the **Getting started example**. The CLI will install all the necessary dependencies and add boilerplate code for you to play with.
 
-Crawlee is available as the [`crawlee`](https://www.npmjs.com/package/crawlee) NPM package and is also available via `@crawlee/*` packages. It provides the following tools:
-
-- [`CheerioCrawler`](https://crawlee.dev/api/cheerio-crawler/class/CheerioCrawler) - Enables the parallel crawling of a large number of web pages using the [cheerio](https://www.npmjs.com/package/cheerio) HTML parser. This is the most efficient web crawler, but it does not work on websites that require JavaScript. Available also under `@crawlee/cheerio` package.
-
-- [`PuppeteerCrawler`](https://crawlee.dev/api/puppeteer-crawler/class/PuppeteerCrawler) - Enables the parallel crawling of a large number of web pages using the headless Chrome browser and [Puppeteer](https://github.com/puppeteer/puppeteer). The pool of Chrome browsers is automatically scaled up and down based on available system resources. Available also under `@crawlee/puppeteer` package.
-
-- [`PlaywrightCrawler`](https://crawlee.dev/api/playwright-crawler/class/PlaywrightCrawler) - Unlike `PuppeteerCrawler` you can use [Playwright](https://github.com/microsoft/playwright) to manage almost any headless browser. It also provides a cleaner and more mature interface while keeping the ease of use and advanced features. Available also under `@crawlee/playwright` package.
-
-- [`BasicCrawler`](https://crawlee.dev/api/basic-crawler/class/BasicCrawler) - Provides a simple framework for the parallel crawling of web pages whose URLs are fed either from a static list or from a dynamic queue of URLs. This class serves as a base for the more specialized crawlers above. Available also under `@crawlee/basic` package.
-
-- [`RequestList`](https://crawlee.dev/api/core/class/RequestList) - Represents a list of URLs to crawl. The URLs can be passed in code or in a text file hosted on the web. The list persists its state so that crawling can resume when the Node.js process restarts. Available also under `@crawlee/core` package.
-
-- [`RequestQueue`](https://crawlee.dev/api/core/class/RequestQueue) - Represents a queue of URLs to crawl, which is stored either in memory, on a local filesystem, or in the [Apify Cloud](https://apify.com). The queue is used for deep crawling of websites, where you start with several URLs and then recursively follow links to other pages. The data structure supports both breadth-first and depth-first crawling orders. Available also under `@crawlee/core` package.
-
-- [`Dataset`](https://crawlee.dev/api/core/class/Dataset) - Provides a store for structured data and enables their export to formats like JSON, JSONL, CSV, XML, Excel or HTML. The data is stored on a local filesystem or in the Apify Cloud. Datasets are useful for storing and sharing large tabular crawling results, such as a list of products or real estate offers. Available also under `@crawlee/core` package.
-
-- [`KeyValueStore`](https://crawlee.dev/api/core/class/KeyValueStore) - A simple key-value store for arbitrary data records or files, along with their MIME content type. It is ideal for saving screenshots of web pages, PDFs or to persist the state of your crawlers. The data is stored on a local filesystem or in the Apify Cloud. Available also under `@crawlee/core` package.
-
-- [`AutoscaledPool`](https://crawlee.dev/api/core/class/AutoscaledPool) - Runs asynchronous background tasks, while automatically adjusting the concurrency based on free system memory and CPU usage. This is useful for running web scraping tasks at the maximum capacity of the system. Available also under `@crawlee/core` package.
-
-Additionally, the package provides various helper functions to simplify running your code on the Apify Cloud and thus take advantage of its pool of proxies, job scheduler, data storage, etc. For more information, see the [Crawlee Programmer's Reference](https://crawlee.dev).
-
-## Quick Start
-
-This short tutorial will set you up to start using Crawlee in a minute or two. If you want to learn more, proceed to the [Getting Started](https://crawlee.dev/docs/introduction) tutorial that will take you step by step through creating your first scraper.
+```bash
+npx crawlee create my-crawler
+```
 
-### Local stand-alone usage
+```bash
+cd my-crawler
+npm start
+```
 
-Crawlee requires [Node.js](https://nodejs.org/en/) 16 or later. Add Crawlee to any Node.js project by running:
+### Manual installation
+If you prefer adding Crawlee **into your own project**, try the example below. Because it uses `PlaywrightCrawler` we also need to install [Playwright](https://playwright.dev). It's not bundled with Crawlee to reduce install size.
 
 ```bash
 npm install crawlee playwright
 ```
 
-> Neither `playwright` nor `puppeteer` are bundled with Crawlee to reduce install size and allow greater flexibility. That's why we install it with NPM. You can choose one, both, or neither.
-
-Run the following example to perform a recursive crawl of a website using Playwright. For more examples showcasing various features of Crawlee, [see the Examples section of the documentation](https://crawlee.dev/docs/examples/crawl-multiple-urls).
-
-```javascript
+```js
 import { PlaywrightCrawler, Dataset } from 'crawlee';
 
-const crawler = new PlaywrightCrawler();
-
-crawler.router.addDefaultHandler(async ({ request, page, enqueueLinks }) => {
-    const title = await page.title();
-    console.log(`Title of ${request.loadedUrl} is '${title}'`);
-
-    // save some results
-    await Dataset.pushData({ title, url: request.loadedUrl });
-
-    // enqueue all links targeting the same hostname
-    await enqueueLinks();
+// PlaywrightCrawler crawls the web using a headless
+// browser controlled by the Playwright library.
+const crawler = new PlaywrightCrawler({
+    // Use the requestHandler to process each of the crawled pages.
+    async requestHandler({ request, page, enqueueLinks, log }) {
+        const title = await page.title();
+        log.info(`Title of ${request.loadedUrl} is '${title}'`);
+
+        // Save results as JSON to ./storage/datasets/default
+        await Dataset.pushData({ title, url: request.loadedUrl });
+
+        // Extract links from the current page
+        // and add them to the crawling queue.
+        await enqueueLinks();
+    },
+    // Uncomment this option to see the browser window.
+    // headless: false,
 });
 
-await crawler.run(['https://www.iana.org/']);
+// Add first URL to the queue and start the crawl.
+await crawler.run(['https://crawlee.dev']);
 ```
 
-When you run the example, you should see Crawlee automating a Chrome browser.
-
-![Chrome Scrape](https://crawlee.dev/img/chrome_scrape.gif)
-
-By default, Crawlee stores data to `./storage` in the current working directory. You can override this directory via `CRAWLEE_STORAGE_DIR` env var. For details, see [Environment variables](https://crawlee.dev/docs/guides/environment-variables), [Request storage](https://crawlee.dev/docs/guides/request-storage) and [Result storage](https://crawlee.dev/docs/guides/result-storage).
-
-### Local usage with Crawlee command-line interface (CLI)
-
-To create a boilerplate of your project we can use the [Crawlee command-line interface (CLI)](https://github.com/apify/apify-cli) tool.
+By default, Crawlee stores data to `./storage` in the current working directory. You can override this directory via Crawlee configuration. For details, see [Configuration guide](https://crawlee.dev/docs/guides/configuration), [Request storage](https://crawlee.dev/docs/guides/request-storage) and [Result storage](https://crawlee.dev/docs/guides/result-storage).
 
-Let's create a boilerplate of your new web crawling project by running:
+## 🛠 Features
 
-```bash
-npx crawlee create my-hello-world
-```
-
-The CLI will prompt you to select a project boilerplate template - just pick "Hello world". The tool will create a directory called `my-hello-world` with a Node.js project files. You can run the project as follows:
+- Single interface for **HTTP and headless browser** crawling
+- Persistent **queue** for URLs to crawl (breadth & depth first)
+- Pluggable **storage** of both tabular data and files
+- Automatic **scaling** with available system resources
+- Integrated **proxy rotation** and session management
+- Lifecycles customizable with **hooks**
+- **CLI** to bootstrap your projects
+- Configurable **routing**, **error handling** and **retries**
+- **Dockerfiles** ready to deploy
+- Written in **TypeScript** with generics
 
-```bash
-cd my-hello-world
-npx crawlee run
-```
+### 👾 HTTP crawling
 
-By default, the crawling data will be stored in a local directory at `./storage`. For example, the input JSON file for the actor is expected to be in the default key-value store in `./storage/key_value_stores/default/INPUT.json`.
+- Zero config **HTTP2 support**, even for proxies
+- Automatic generation of **browser-like headers**
+- Replication of browser **TLS fingerprints**
+- Integrated fast **HTML parsers**. Cheerio and JSDOM
+- Yes, you can scrape **JSON APIs** as well
 
-### Usage on the Apify platform
-
-Now if we want to run our new crawler on Apify Platform, we first need to download the `apify-cli` and login with our token:
-
-> We could also use the Apify CLI to generate a new project, which can be better suited if we want to run it on the Apify Platform.
-
-```bash
-npm i -g apify-cli
-apify login
-```
-
-Finally, we can easily deploy our code to the Apify platform by running:
-
-```bash
-apify push
-```
+### 💻 Real browser crawling
 
-Your script will be uploaded to the Apify platform and built there so that it can be run. For more information, view the
-[Apify Actor](https://docs.apify.com/cli) documentation.
+- JavaScript **rendering** and **screenshots**
+- **Headless** and **headful** support
+- Zero-config generation of **human-like fingerprints**
+- Automatic **browser management**
+- Use **Playwright** and **Puppeteer** with the same interface
+- **Chrome**, **Firefox**, **Webkit** and many others
 
-You can also develop your web scraping project in an online code editor directly on the [Apify platform](https://crawlee.dev/docs/guides/apify-platform). You'll need to have an Apify Account. Go to [Actors](https://console.apify.com/actors), page in the Apify Console, click <i>Create new</i> and then go to the <i>Source</i> tab and start writing your code or paste one of the examples from the Examples section.
+## Usage on the Apify platform
 
-For more information, view the [Apify actors quick start guide](https://docs.apify.com/actor/quick-start).
+Crawlee is open-source and runs anywhere, but since it's developed by [Apify](https://apify.com), it's easy to set up on the Apify platform and run in the cloud. Visit the [Apify SDK website](https://sdk.apify.com) to learn more about deploying Crawlee to the Apify platform.
 
 ## Support
 
-If you find any bug or issue with Crawlee, please [submit an issue on GitHub](https://github.com/apify/crawlee/issues). For questions, you can ask on [Stack Overflow](https://stackoverflow.com/questions/tagged/apify) or contact support@apify.com
+If you find any bug or issue with Crawlee, please [submit an issue on GitHub](https://github.com/apify/crawlee/issues). For questions, you can ask on [Stack Overflow](https://stackoverflow.com/questions/tagged/apify), in GitHub Discussions or you can join our [Discord server](https://discord.com/invite/jyEM2PRvMU).
 
 ## Contributing
 

package/manifest.json

@@ -1,28 +1,36 @@
 {
     "templates": [
+        {
+            "name": "getting-started-ts",
+            "description": "Getting started example [TypeScript]"
+        },
+        {
+            "name": "getting-started-js",
+            "description": "Getting started example [JavaScript]"
+        },
         {
             "name": "cheerio-ts",
-            "description": "Crawlee cheerio template [TypeScript]"
+            "description": "CheerioCrawler template project [TypeScript]"
         },
         {
             "name": "playwright-ts",
-            "description": "Crawlee playwright template [TypeScript]"
+            "description": "PlaywrightCrawler template project [TypeScript]"
         },
         {
             "name": "puppeteer-ts",
-            "description": "Crawlee puppeteer template [TypeScript]"
+            "description": "PuppeteerCrawler template project [TypeScript]"
         },
         {
             "name": "cheerio-js",
-            "description": "Crawlee cheerio template [JavaScript]"
+            "description": "CheerioCrawler template project [JavaScript]"
         },
         {
             "name": "playwright-js",
-            "description": "Crawlee playwright template [JavaScript]"
+            "description": "PlaywrightCrawler template project [JavaScript]"
         },
         {
             "name": "puppeteer-js",
-            "description": "Crawlee puppeteer template [JavaScript]"
+            "description": "PuppeteerCrawler template project [JavaScript]"
         }
     ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@crawlee/templates",
-    "version": "3.0.4-beta.6",
+    "version": "3.0.4-beta.9",
     "description": "Templates for the crawlee projects",
     "engines": {
         "node": ">=16.0.0"

package/templates/cheerio-js/.dockerignore

@@ -0,0 +1,10 @@
+# configurations
+.idea
+
+# crawlee and apify storage folders
+apify_storage
+crawlee_storage
+storage
+
+# installed files
+node_modules

package/templates/cheerio-js/Dockerfile

@@ -1,15 +1,29 @@
+# Specify the base Docker image. You can read more about
+# the available images at https://crawlee.dev/docs/guides/docker-images
+# You can also use any other image from Docker Hub.
 FROM apify/actor-node:16
 
-# copy package.json, lock file and possibly crawlee.json
-COPY package*.json crawlee?json ./
-COPY src ./src
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY package*.json ./
 
-# install only prod deps
+# Install NPM packages, skip optional and development dependencies to
+# keep the image small. Avoid logging too much and print the dependency
+# tree for debugging
 RUN npm --quiet set progress=false \
-    && npm install --only=prod --no-optional \
+    && npm install --omit=dev --omit=optional \
     && echo "Installed NPM packages:" \
-    && (npm list --only=prod --no-optional --all || true) \
+    && (npm list --omit=dev --all || true) \
     && echo "Node.js version:" \
     && node --version \
     && echo "NPM version:" \
     && npm --version
+
+# Next, copy the remaining files and directories with the source code.
+# Since we do this after NPM install, quick build will be really fast
+# for most source file changes.
+COPY . ./
+
+
+# Run the image.
+CMD npm start --silent

package/templates/cheerio-js/package.json

@@ -8,7 +8,6 @@
     },
     "scripts": {
         "start": "node src/main.js",
-        "build": "tsc",
         "test": "echo \"Error: oops, the actor has no tests yet, sad!\" && exit 1"
     },
     "author": "It's not you it's me",

package/templates/cheerio-js/src/routes.js

@@ -3,19 +3,19 @@ import { Dataset, createCheerioRouter } from 'crawlee';
 export const router = createCheerioRouter();
 
 router.addDefaultHandler(async ({ enqueueLinks, log }) => {
-    log.info(`Handle Start URLs`);
+    log.info(`enqueueing new URLs`);
     await enqueueLinks({
         globs: ['https://crawlee.dev/**'],
-        label: 'DETAIL',
+        label: 'detail',
     });
 });
 
-router.addHandler('LIST', async ({ log }) => {
-    log.info(`Handle pagination`);
-});
-
-router.addHandler('DETAIL', async ({ request, $, log }) => {
+router.addHandler('detail', async ({ request, $, log }) => {
     const title = $('title').text();
-    log.info(`Handle details: ${title} [${request.loadedUrl}]`);
-    await Dataset.pushData({ url: request.loadedUrl });
+    log.info(`${title}`, { url: request.loadedUrl });
+
+    await Dataset.pushData({
+        url: request.loadedUrl,
+        title,
+    });
 });

package/templates/cheerio-ts/.dockerignore

@@ -0,0 +1,10 @@
+# configurations
+.idea
+
+# crawlee and apify storage folders
+apify_storage
+crawlee_storage
+storage
+
+# installed files
+node_modules

package/templates/cheerio-ts/Dockerfile

@@ -1,32 +1,50 @@
-# First, specify the base Docker image. You can read more about
+# Specify the base Docker image. You can read more about
 # the available images at https://crawlee.dev/docs/guides/docker-images
 # You can also use any other image from Docker Hub.
 FROM apify/actor-node:16 AS builder
 
-# Second, copy the TS source files, package.json and package-lock.json since it should be
-# the only files that affects the installation and build in the next step
-COPY package*.json tsconfig.json crawlee?json ./
-COPY src ./src
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY package*.json ./
 
-# Install all dependencies (including dev deps) and build the project
-RUN npm install --include=dev && npm run build
+# Install all dependencies. Don't audit to speed up the installation.
+RUN npm install --include=dev --audit=false
+
+# Next, copy the source files using the user set
+# in the base image.
+COPY . ./
+
+# Install all dependencies and build the project.
+# Don't audit to speed up the installation.
+RUN npm run build
 
 # Create final image
 FROM apify/actor-node:16
 
-# Copy only necessary files (crawlee.json might not exist, so we need the regexp trick with `crawlee?json`)
-COPY --from=builder /usr/src/app/package.json /usr/src/app/crawlee?json ./
+# Copy only built JS files from builder image
 COPY --from=builder /usr/src/app/dist ./dist
 
-# Install only prod deps
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY package*.json ./
+
+# Install NPM packages, skip optional and development dependencies to
+# keep the image small. Avoid logging too much and print the dependency
+# tree for debugging
 RUN npm --quiet set progress=false \
-    && npm install --only=prod --no-optional \
+    && npm install --omit=dev --omit=optional \
     && echo "Installed NPM packages:" \
-    && (npm list --only=prod --no-optional --all || true) \
+    && (npm list --omit=dev --all || true) \
     && echo "Node.js version:" \
     && node --version \
     && echo "NPM version:" \
     && npm --version
 
-# Run compiled code
-CMD npm run start:prod
+# Next, copy the remaining files and directories with the source code.
+# Since we do this after NPM install, quick build will be really fast
+# for most source file changes.
+COPY . ./
+
+
+# Run the image.
+CMD npm run start:prod --silent

package/templates/cheerio-ts/src/routes.ts

@@ -1,21 +1,21 @@
-import { createCheerioRouter, Dataset } from 'crawlee';
+import { Dataset, createCheerioRouter } from 'crawlee';
 
 export const router = createCheerioRouter();
 
 router.addDefaultHandler(async ({ enqueueLinks, log }) => {
-    log.info(`Handle Start URLs`);
+    log.info(`enqueueing new URLs`);
     await enqueueLinks({
         globs: ['https://crawlee.dev/**'],
-        label: 'DETAIL',
+        label: 'detail',
     });
 });
 
-router.addHandler('LIST', async ({ log }) => {
-    log.info(`Handle pagination`);
-});
-
-router.addHandler('DETAIL', async ({ request, $, log }) => {
+router.addHandler('detail', async ({ request, $, log }) => {
     const title = $('title').text();
-    log.info(`Handle details: ${title} [${request.loadedUrl}]`);
-    await Dataset.pushData({ url: request.loadedUrl });
+    log.info(`${title}`, { url: request.loadedUrl });
+
+    await Dataset.pushData({
+        url: request.loadedUrl,
+        title,
+    });
 });

package/templates/getting-started-js/.dockerignore

@@ -0,0 +1,10 @@
+# configurations
+.idea
+
+# crawlee and apify storage folders
+apify_storage
+crawlee_storage
+storage
+
+# installed files
+node_modules

package/templates/getting-started-js/Dockerfile

@@ -0,0 +1,29 @@
+# Specify the base Docker image. You can read more about
+# the available images at https://crawlee.dev/docs/guides/docker-images
+# You can also use any other image from Docker Hub.
+FROM apify/actor-node-playwright-chrome:16
+
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY --chown=myuser package*.json ./
+
+# Install NPM packages, skip optional and development dependencies to
+# keep the image small. Avoid logging too much and print the dependency
+# tree for debugging
+RUN npm --quiet set progress=false \
+    && npm install --omit=dev --omit=optional \
+    && echo "Installed NPM packages:" \
+    && (npm list --omit=dev --all || true) \
+    && echo "Node.js version:" \
+    && node --version \
+    && echo "NPM version:" \
+    && npm --version
+
+# Next, copy the remaining files and directories with the source code.
+# Since we do this after NPM install, quick build will be really fast
+# for most source file changes.
+COPY --chown=myuser . ./
+
+
+# Run the image.
+CMD npm start --silent

package/templates/getting-started-js/README.md

@@ -0,0 +1,9 @@
+# Getting started with Crawlee
+
+This example uses `PlaywrightCrawler` to recursively crawl https://crawlee.dev using the browser automation library [Playwright](https://playwright.dev).
+
+You can find more examples and documentation at the following links:
+
+- [Step-by-step tutorial](https://crawlee.dev/docs/introduction) for Crawlee
+- `PlaywrightCrawler` [API documentation](https://crawlee.dev/api/playwright-crawler/class/PlaywrightCrawler)
+- Other [examples](https://crawlee.dev/docs/examples/playwright-crawler)

package/templates/getting-started-js/package.json

@@ -0,0 +1,16 @@
+{
+    "name": "crawlee-getting-started-js",
+    "version": "0.0.1",
+    "type": "module",
+    "description": "This is an example of a Crawlee project.",
+    "dependencies": {
+        "crawlee": "^3.0.0",
+        "playwright": "*"
+    },
+    "scripts": {
+        "start": "node src/main.js",
+        "test": "echo \"Error: oops, the actor has no tests yet, sad!\" && exit 1"
+    },
+    "author": "It's not you it's me",
+    "license": "ISC"
+}

package/templates/getting-started-js/src/main.js

@@ -0,0 +1,24 @@
+// For more information, see https://crawlee.dev/
+import { PlaywrightCrawler, Dataset } from 'crawlee';
+
+// PlaywrightCrawler crawls the web using a headless
+// browser controlled by the Playwright library.
+const crawler = new PlaywrightCrawler({
+    // Use the requestHandler to process each of the crawled pages.
+    async requestHandler({ request, page, enqueueLinks, log }) {
+        const title = await page.title();
+        log.info(`Title of ${request.loadedUrl} is '${title}'`);
+
+        // Save results as JSON to ./storage/datasets/default
+        await Dataset.pushData({ title, url: request.loadedUrl });
+
+        // Extract links from the current page
+        // and add them to the crawling queue.
+        await enqueueLinks();
+    },
+    // Uncomment this option to see the browser window.
+    // headless: false,
+});
+
+// Add first URL to the queue and start the crawl.
+await crawler.run(['https://crawlee.dev']);

package/templates/getting-started-ts/.dockerignore

@@ -0,0 +1,10 @@
+# configurations
+.idea
+
+# crawlee and apify storage folders
+apify_storage
+crawlee_storage
+storage
+
+# installed files
+node_modules

package/templates/getting-started-ts/Dockerfile

@@ -0,0 +1,51 @@
+# Specify the base Docker image. You can read more about
+# the available images at https://crawlee.dev/docs/guides/docker-images
+# You can also use any other image from Docker Hub.
+FROM apify/actor-node-playwright-chrome:16 AS builder
+
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY --chown=myuser package*.json ./
+
+# Install all dependencies. Don't audit to speed up the installation.
+RUN npm install --include=dev --audit=false
+
+# Next, copy the source files using the user set
+# in the base image.
+COPY --chown=myuser . ./
+
+# Install all dependencies and build the project.
+# Don't audit to speed up the installation.
+RUN npm run build
+
+# Create final image
+FROM apify/actor-node-playwright-chrome:16
+
+# Copy only built JS files from builder image
+COPY --from=builder --chown=myuser /home/myuser/dist ./dist
+
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY --chown=myuser package*.json ./
+
+# Install NPM packages, skip optional and development dependencies to
+# keep the image small. Avoid logging too much and print the dependency
+# tree for debugging
+RUN npm --quiet set progress=false \
+    && npm install --omit=dev --omit=optional \
+    && echo "Installed NPM packages:" \
+    && (npm list --omit=dev --all || true) \
+    && echo "Node.js version:" \
+    && node --version \
+    && echo "NPM version:" \
+    && npm --version
+
+# Next, copy the remaining files and directories with the source code.
+# Since we do this after NPM install, quick build will be really fast
+# for most source file changes.
+COPY --chown=myuser . ./
+
+
+# Run the image. If you know you won't need headful browsers,
+# you can remove the XVFB start script for a micro perf gain.
+CMD ./start_xvfb_and_run_cmd.sh && npm run start:prod --silent

package/templates/getting-started-ts/README.md

@@ -0,0 +1,9 @@
+# Getting started with Crawlee
+
+This example uses `PlaywrightCrawler` to recursively crawl https://crawlee.dev using the browser automation library [Playwright](https://playwright.dev).
+
+You can find more examples and documentation at the following links:
+
+- [Step-by-step tutorial](https://crawlee.dev/docs/introduction) for Crawlee
+- `PlaywrightCrawler` [API documentation](https://crawlee.dev/api/playwright-crawler/class/PlaywrightCrawler)
+- Other [examples](https://crawlee.dev/docs/examples/playwright-crawler)

package/templates/getting-started-ts/package.json

@@ -0,0 +1,24 @@
+{
+    "name": "crawlee-getting-started-ts",
+    "version": "0.0.1",
+    "type": "module",
+    "description": "This is an example of a Crawlee project.",
+    "dependencies": {
+        "crawlee": "^3.0.0",
+        "playwright": "*"
+    },
+    "devDependencies": {
+        "@apify/tsconfig": "^0.1.0",
+        "ts-node": "^10.8.0",
+        "typescript": "^4.7.4"
+    },
+    "scripts": {
+        "start": "npm run start:dev",
+        "start:prod": "node dist/main.js",
+        "start:dev": "ts-node-esm -T src/main.ts",
+        "build": "tsc",
+        "test": "echo \"Error: oops, the actor has no tests yet, sad!\" && exit 1"
+    },
+    "author": "It's not you it's me",
+    "license": "ISC"
+}

package/templates/getting-started-ts/src/main.ts

@@ -0,0 +1,24 @@
+// For more information, see https://crawlee.dev/
+import { PlaywrightCrawler, Dataset } from 'crawlee';
+
+// PlaywrightCrawler crawls the web using a headless
+// browser controlled by the Playwright library.
+const crawler = new PlaywrightCrawler({
+    // Use the requestHandler to process each of the crawled pages.
+    async requestHandler({ request, page, enqueueLinks, log }) {
+        const title = await page.title();
+        log.info(`Title of ${request.loadedUrl} is '${title}'`);
+
+        // Save results as JSON to ./storage/datasets/default
+        await Dataset.pushData({ title, url: request.loadedUrl });
+
+        // Extract links from the current page
+        // and add them to the crawling queue.
+        await enqueueLinks();
+    },
+    // Uncomment this option to see the browser window.
+    // headless: false,
+});
+
+// Add first URL to the queue and start the crawl.
+await crawler.run(['https://crawlee.dev']);

package/templates/getting-started-ts/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "extends": "@apify/tsconfig",
+    "compilerOptions": {
+        "module": "ES2022",
+        "target": "ES2022",
+        "outDir": "dist",
+        "noUnusedLocals": false,
+        "lib": ["DOM"]
+    },
+    "include": [
+        "./src/**/*"
+    ]
+}

package/templates/playwright-js/.dockerignore

@@ -0,0 +1,10 @@
+# configurations
+.idea
+
+# crawlee and apify storage folders
+apify_storage
+crawlee_storage
+storage
+
+# installed files
+node_modules

package/templates/playwright-js/Dockerfile

@@ -1,15 +1,29 @@
+# Specify the base Docker image. You can read more about
+# the available images at https://crawlee.dev/docs/guides/docker-images
+# You can also use any other image from Docker Hub.
 FROM apify/actor-node-playwright-chrome:16
 
-# copy package.json, lock file and possibly crawlee.json
-COPY package*.json crawlee?json ./
-COPY src ./src
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY --chown=myuser package*.json ./
 
-# install only prod deps
+# Install NPM packages, skip optional and development dependencies to
+# keep the image small. Avoid logging too much and print the dependency
+# tree for debugging
 RUN npm --quiet set progress=false \
-    && npm install --only=prod --no-optional \
+    && npm install --omit=dev --omit=optional \
     && echo "Installed NPM packages:" \
-    && (npm list --only=prod --no-optional --all || true) \
+    && (npm list --omit=dev --all || true) \
     && echo "Node.js version:" \
     && node --version \
     && echo "NPM version:" \
     && npm --version
+
+# Next, copy the remaining files and directories with the source code.
+# Since we do this after NPM install, quick build will be really fast
+# for most source file changes.
+COPY --chown=myuser . ./
+
+
+# Run the image.
+CMD npm start --silent

package/templates/playwright-js/README.md

@@ -6,21 +6,3 @@ If you're looking for examples or want to learn more visit:
 
 - [Documentation](https://crawlee.dev/api/playwright-crawler/class/PlaywrightCrawler)
 - [Examples](https://crawlee.dev/docs/examples/playwright-crawler)
-
-## Writing a README
-
-See our tutorial on [writing READMEs for your actors](https://help.apify.com/en/articles/2912548-how-to-write-great-readme-for-your-actors) if you need more inspiration.
-
-### Table of contents
-
-If your README requires a table of contents, use the template below and make sure to keep the `<!-- toc start -->` and `<!-- toc end -->` markers.
-
-<!-- toc start -->
-- Introduction
-- Use Cases
-    - Case 1
-    - Case 2
-- Input
-- Output
-- Miscellaneous
- <!-- toc end -->

package/templates/playwright-js/package.json

@@ -9,7 +9,6 @@
     },
     "scripts": {
         "start": "node src/main.js",
-        "build": "tsc",
         "test": "echo \"Error: oops, the actor has no tests yet, sad!\" && exit 1"
     },
     "author": "It's not you it's me",

package/templates/playwright-js/src/routes.js

@@ -3,19 +3,19 @@ import { Dataset, createPlaywrightRouter } from 'crawlee';
 export const router = createPlaywrightRouter();
 
 router.addDefaultHandler(async ({ enqueueLinks, log }) => {
-    log.info(`Handle Start URLs`);
+    log.info(`enqueueing new URLs`);
     await enqueueLinks({
         globs: ['https://crawlee.dev/**'],
-        label: 'DETAIL',
+        label: 'detail',
     });
 });
 
-router.addHandler('handleList', async ({ log }) => {
-    log.info(`Handle pagination`);
-});
-
-router.addHandler('handleDetail', async ({ request, page, log }) => {
+router.addHandler('detail', async ({ request, page, log }) => {
     const title = await page.title();
-    log.info(`Handle details: ${title} [${request.loadedUrl}]`);
-    await Dataset.pushData({ url: request.loadedUrl });
+    log.info(`${title}`, { url: request.loadedUrl });
+
+    await Dataset.pushData({
+        url: request.loadedUrl,
+        title,
+    });
 });

package/templates/playwright-ts/.dockerignore

@@ -0,0 +1,10 @@
+# configurations
+.idea
+
+# crawlee and apify storage folders
+apify_storage
+crawlee_storage
+storage
+
+# installed files
+node_modules

package/templates/playwright-ts/Dockerfile

@@ -1,32 +1,51 @@
-# First, specify the base Docker image. You can read more about
+# Specify the base Docker image. You can read more about
 # the available images at https://crawlee.dev/docs/guides/docker-images
 # You can also use any other image from Docker Hub.
-FROM apify/actor-node:16 AS builder
+FROM apify/actor-node-playwright-chrome:16 AS builder
 
-# Second, copy the TS source files, package.json and package-lock.json since it should be
-# the only files that affects the installation and build in the next step
-COPY package*.json tsconfig.json crawlee?json ./
-COPY src ./src
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY --chown=myuser package*.json ./
 
-# Install all dependencies (including dev deps) and build the project
-RUN npm install --include=dev && npm run build
+# Install all dependencies. Don't audit to speed up the installation.
+RUN npm install --include=dev --audit=false
+
+# Next, copy the source files using the user set
+# in the base image.
+COPY --chown=myuser . ./
+
+# Install all dependencies and build the project.
+# Don't audit to speed up the installation.
+RUN npm run build
 
 # Create final image
 FROM apify/actor-node-playwright-chrome:16
 
-# Copy only necessary files (crawlee.json might not exist, so we need the regexp trick with `crawlee?json`)
-COPY --from=builder /usr/src/app/package.json /usr/src/app/crawlee?json ./
-COPY --from=builder /usr/src/app/dist ./dist
+# Copy only built JS files from builder image
+COPY --from=builder --chown=myuser /home/myuser/dist ./dist
+
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY --chown=myuser package*.json ./
 
-# Install only prod deps
+# Install NPM packages, skip optional and development dependencies to
+# keep the image small. Avoid logging too much and print the dependency
+# tree for debugging
 RUN npm --quiet set progress=false \
-    && npm install --only=prod --no-optional \
+    && npm install --omit=dev --omit=optional \
     && echo "Installed NPM packages:" \
-    && (npm list --only=prod --no-optional --all || true) \
+    && (npm list --omit=dev --all || true) \
     && echo "Node.js version:" \
     && node --version \
     && echo "NPM version:" \
     && npm --version
 
-# Run compiled code
-CMD ./start_xvfb_and_run_cmd.sh && npm run start:prod
+# Next, copy the remaining files and directories with the source code.
+# Since we do this after NPM install, quick build will be really fast
+# for most source file changes.
+COPY --chown=myuser . ./
+
+
+# Run the image. If you know you won't need headful browsers,
+# you can remove the XVFB start script for a micro perf gain.
+CMD ./start_xvfb_and_run_cmd.sh && npm run start:prod --silent

package/templates/playwright-ts/README.md

@@ -6,21 +6,3 @@ If you're looking for examples or want to learn more visit:
 
 - [Documentation](https://crawlee.dev/api/playwright-crawler/class/PlaywrightCrawler)
 - [Examples](https://crawlee.dev/docs/examples/playwright-crawler)
-
-## Writing a README
-
-See our tutorial on [writing READMEs for your actors](https://help.apify.com/en/articles/2912548-how-to-write-great-readme-for-your-actors) if you need more inspiration.
-
-### Table of contents
-
-If your README requires a table of contents, use the template below and make sure to keep the `<!-- toc start -->` and `<!-- toc end -->` markers.
-
-<!-- toc start -->
-- Introduction
-- Use Cases
-    - Case 1
-    - Case 2
-- Input
-- Output
-- Miscellaneous
- <!-- toc end -->

package/templates/playwright-ts/src/routes.ts

@@ -3,19 +3,19 @@ import { Dataset, createPlaywrightRouter } from 'crawlee';
 export const router = createPlaywrightRouter();
 
 router.addDefaultHandler(async ({ enqueueLinks, log }) => {
-    log.info(`Handle Start URLs`);
+    log.info(`enqueueing new URLs`);
     await enqueueLinks({
         globs: ['https://crawlee.dev/**'],
-        label: 'DETAIL',
+        label: 'detail',
     });
 });
 
-router.addHandler('handleList', async ({ log }) => {
-    log.info(`Handle pagination`);
-});
-
-router.addHandler('handleDetail', async ({ request, page, log }) => {
+router.addHandler('detail', async ({ request, page, log }) => {
     const title = await page.title();
-    log.info(`Handle details: ${title} [${request.loadedUrl}]`);
-    await Dataset.pushData({ url: request.loadedUrl });
+    log.info(`${title}`, { url: request.loadedUrl });
+
+    await Dataset.pushData({
+        url: request.loadedUrl,
+        title,
+    });
 });

package/templates/puppeteer-js/.dockerignore

@@ -0,0 +1,10 @@
+# configurations
+.idea
+
+# crawlee and apify storage folders
+apify_storage
+crawlee_storage
+storage
+
+# installed files
+node_modules

package/templates/puppeteer-js/Dockerfile

@@ -1,15 +1,29 @@
+# Specify the base Docker image. You can read more about
+# the available images at https://crawlee.dev/docs/guides/docker-images
+# You can also use any other image from Docker Hub.
 FROM apify/actor-node-puppeteer-chrome:16
 
-# copy package.json, lock file and possibly crawlee.json
-COPY package*.json crawlee?json ./
-COPY src ./src
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY --chown=myuser package*.json ./
 
-# install only prod deps
+# Install NPM packages, skip optional and development dependencies to
+# keep the image small. Avoid logging too much and print the dependency
+# tree for debugging
 RUN npm --quiet set progress=false \
-    && npm install --only=prod --no-optional \
+    && npm install --omit=dev --omit=optional \
     && echo "Installed NPM packages:" \
-    && (npm list --only=prod --no-optional --all || true) \
+    && (npm list --omit=dev --all || true) \
     && echo "Node.js version:" \
     && node --version \
     && echo "NPM version:" \
     && npm --version
+
+# Next, copy the remaining files and directories with the source code.
+# Since we do this after NPM install, quick build will be really fast
+# for most source file changes.
+COPY --chown=myuser . ./
+
+
+# Run the image.
+CMD npm start --silent

package/templates/puppeteer-js/README.md

@@ -6,21 +6,3 @@ If you're looking for examples or want to learn more visit:
 
 - [Documentation](https://crawlee.dev/api/puppeteer-crawler/class/PuppeteerCrawler)
 - [Examples](https://crawlee.dev/docs/examples/puppeteer-crawler)
-
-## Writing a README
-
-See our tutorial on [writing READMEs for your actors](https://help.apify.com/en/articles/2912548-how-to-write-great-readme-for-your-actors) if you need more inspiration.
-
-### Table of contents
-
-If your README requires a table of contents, use the template below and make sure to keep the `<!-- toc start -->` and `<!-- toc end -->` markers.
-
-<!-- toc start -->
-- Introduction
-- Use Cases
-    - Case 1
-    - Case 2
-- Input
-- Output
-- Miscellaneous
- <!-- toc end -->

package/templates/puppeteer-js/package.json

@@ -9,7 +9,6 @@
     },
     "scripts": {
         "start": "node src/main.js",
-        "build": "tsc",
         "test": "echo \"Error: oops, the actor has no tests yet, sad!\" && exit 1"
     },
     "author": "It's not you it's me",

package/templates/puppeteer-js/src/routes.js

@@ -3,19 +3,19 @@ import { Dataset, createPuppeteerRouter } from 'crawlee';
 export const router = createPuppeteerRouter();
 
 router.addDefaultHandler(async ({ enqueueLinks, log }) => {
-    log.info(`Handle Start URLs`);
+    log.info(`enqueueing new URLs`);
     await enqueueLinks({
         globs: ['https://crawlee.dev/**'],
-        label: 'DETAIL',
+        label: 'detail',
     });
 });
 
-router.addHandler('handleList', async ({ log }) => {
-    log.info(`Handle pagination`);
-});
-
-router.addHandler('handleDetail', async ({ request, page, log }) => {
+router.addHandler('detail', async ({ request, page, log }) => {
     const title = await page.title();
-    log.info(`Handle details: ${title} [${request.loadedUrl}]`);
-    await Dataset.pushData({ url: request.loadedUrl });
+    log.info(`${title}`, { url: request.loadedUrl });
+
+    await Dataset.pushData({
+        url: request.loadedUrl,
+        title,
+    });
 });

package/templates/puppeteer-ts/.dockerignore

@@ -0,0 +1,10 @@
+# configurations
+.idea
+
+# crawlee and apify storage folders
+apify_storage
+crawlee_storage
+storage
+
+# installed files
+node_modules

package/templates/puppeteer-ts/Dockerfile

@@ -1,32 +1,51 @@
-# First, specify the base Docker image. You can read more about
+# Specify the base Docker image. You can read more about
 # the available images at https://crawlee.dev/docs/guides/docker-images
 # You can also use any other image from Docker Hub.
-FROM apify/actor-node:16 AS builder
+FROM apify/actor-node-puppeteer-chrome:16 AS builder
 
-# Second, copy the TS source files, package.json and package-lock.json since it should be
-# the only files that affects the installation and build in the next step
-COPY package*.json tsconfig.json crawlee?json ./
-COPY src ./src
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY --chown=myuser package*.json ./
 
-# Install all dependencies (including dev deps) and build the project
-RUN npm install --include=dev && npm run build
+# Install all dependencies. Don't audit to speed up the installation.
+RUN npm install --include=dev --audit=false
+
+# Next, copy the source files using the user set
+# in the base image.
+COPY --chown=myuser . ./
+
+# Install all dependencies and build the project.
+# Don't audit to speed up the installation.
+RUN npm run build
 
 # Create final image
 FROM apify/actor-node-puppeteer-chrome:16
 
-# Copy only necessary files (crawlee.json might not exist, so we need the regexp trick with `crawlee?json`)
-COPY --from=builder /usr/src/app/package.json /usr/src/app/crawlee?json ./
-COPY --from=builder /usr/src/app/dist ./dist
+# Copy only built JS files from builder image
+COPY --from=builder --chown=myuser /home/myuser/dist ./dist
+
+# Copy just package.json and package-lock.json
+# to speed up the build using Docker layer cache.
+COPY --chown=myuser package*.json ./
 
-# Install only prod deps
+# Install NPM packages, skip optional and development dependencies to
+# keep the image small. Avoid logging too much and print the dependency
+# tree for debugging
 RUN npm --quiet set progress=false \
-    && npm install --only=prod --no-optional \
+    && npm install --omit=dev --omit=optional \
     && echo "Installed NPM packages:" \
-    && (npm list --only=prod --no-optional --all || true) \
+    && (npm list --omit=dev --all || true) \
     && echo "Node.js version:" \
     && node --version \
     && echo "NPM version:" \
     && npm --version
 
-# Run compiled code
-CMD ./start_xvfb_and_run_cmd.sh && npm run start:prod
+# Next, copy the remaining files and directories with the source code.
+# Since we do this after NPM install, quick build will be really fast
+# for most source file changes.
+COPY --chown=myuser . ./
+
+
+# Run the image. If you know you won't need headful browsers,
+# you can remove the XVFB start script for a micro perf gain.
+CMD ./start_xvfb_and_run_cmd.sh && npm run start:prod --silent

package/templates/puppeteer-ts/README.md

@@ -6,21 +6,3 @@ If you're looking for examples or want to learn more visit:
 
 - [Documentation](https://crawlee.dev/api/puppeteer-crawler/class/PuppeteerCrawler)
 - [Examples](https://crawlee.dev/docs/examples/puppeteer-crawler)
-
-## Writing a README
-
-See our tutorial on [writing READMEs for your actors](https://help.apify.com/en/articles/2912548-how-to-write-great-readme-for-your-actors) if you need more inspiration.
-
-### Table of contents
-
-If your README requires a table of contents, use the template below and make sure to keep the `<!-- toc start -->` and `<!-- toc end -->` markers.
-
-<!-- toc start -->
-- Introduction
-- Use Cases
-    - Case 1
-    - Case 2
-- Input
-- Output
-- Miscellaneous
- <!-- toc end -->

package/templates/puppeteer-ts/src/routes.ts

@@ -3,19 +3,19 @@ import { Dataset, createPuppeteerRouter } from 'crawlee';
 export const router = createPuppeteerRouter();
 
 router.addDefaultHandler(async ({ enqueueLinks, log }) => {
-    log.info(`Handle Start URLs`);
+    log.info(`enqueueing new URLs`);
     await enqueueLinks({
         globs: ['https://crawlee.dev/**'],
-        label: 'DETAIL',
+        label: 'detail',
     });
 });
 
-router.addHandler('handleList', async ({ log }) => {
-    log.info(`Handle pagination`);
-});
-
-router.addHandler('handleDetail', async ({ request, page, log }) => {
+router.addHandler('detail', async ({ request, page, log }) => {
     const title = await page.title();
-    log.info(`Handle details: ${title} [${request.loadedUrl}]`);
-    await Dataset.pushData({ url: request.loadedUrl });
+    log.info(`${title}`, { url: request.loadedUrl });
+
+    await Dataset.pushData({
+        url: request.loadedUrl,
+        title,
+    });
 });