Skip to content

start_web_ide.md

Latest commit

 

History

History
153 lines (91 loc) · 5.33 KB

start_web_ide.md

File metadata and controls

153 lines (91 loc) · 5.33 KB
title Web IDE
sidebar_position 2
description Create and run your first Actor using the web IDE in Apify Console, from writing your first lines of code to deploying it live in the cloud.
slug /actors/development/quick-start/web-ide

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

What you'll learn

This guide walks you through the full lifecycle of an Actor using the web IDE in Apify Console. You'll create an Actor from a code template, build it, configure its input, and run it in the cloud.

Prerequisites

Step 1: Create your Actor

Log in to Apify Console, navigate to My Actors, then click the Develop new button.

Create Actor

You'll see options to link a Git repository, select a code template, or push code with the Apify CLI.

Under Select a code template, you'll find quick-start templates for TypeScript, Python, and JavaScript. Click Browse all templates to see the full list. Choose the template that best suits your needs. For the following demo, we'll proceed with a Crawlee + Cheerio template.

:::info Explore Actor templates

Browse the full list of templates to find the best fit for your Actor.

:::

Templates

After choosing the template, your Actor will be automatically named and you'll be redirected to its page.

Step 2: Explore the Actor

The provided boilerplate code utilizes the Apify SDK combined with Crawlee, Apify's popular open-source Node.js web scraping library.

By default, the code crawls the apify.com website, but you can change it to any website.

:::info Crawlee

Crawlee is an open-source Node.js library designed for web scraping and browser automation. It helps you build reliable crawlers quickly and efficiently.

:::

Step 3: Build the Actor

To run your Actor, build it first. Click the Build button below the source code.

Actor source code

Once the build starts, the UI transitions to the Last build tab, showing build progress and Docker build logs.

Actor build

:::note Actor creation flow

The UI includes four tabs:

  • Code
  • Last build
  • Input
  • Last run

This represents the Actor creation flow, where you first build the Actor from the source code. Once the build is successful, you can provide input parameters and initiate an Actor run.

:::

Step 4: Run the Actor

Once the Actor is built, you can look at its input, which consists of one field - Start URL, the URL where the crawling starts. Below the input, you can adjust the Run options:

  • Build
  • Timeout
  • Memory limit

Actor input

To initiate an Actor run, click the Start button at the bottom of the page. Once the run is created, you can monitor its progress and view the log in real-time. The Output tab will display the results of the Actor's execution, which will be populated as the run progresses. You can abort the run at any time using the Abort button.

Actor run

Step 5: Pull the Actor

To continue development locally, pull the Actor's source code to your machine.

:::note Prerequisites

Install apify-cli :

brew install apify-cli
npm -g install apify-cli

:::

To pull your Actor:

  1. Log in to the Apify platform

    apify login

  2. Pull your Actor:

    apify pull your-actor-name

    Or with a specific version:

    apify pull your-actor-name --version [version_number]

    As your-actor-name, you can use either:

    • The unique name of the Actor (e.g., apify/hello-world)
    • The ID of the Actor (e.g., E2jjCZBezvAZnX8Rb)

You can find both by clicking on the Actor title at the top of the page, which will open a new window containing the Actor's unique name and ID.

Step 6: It's time to iterate!

After pulling the Actor's source code to your local machine, you can modify and customize it to match your specific requirements. Leverage your preferred code editor or development environment to make the necessary changes and enhancements.

Once you've made the desired changes, you can push the updated code back to the Apify platform for deployment & execution, leveraging the platform's scalability and reliability.

Next steps