You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sources/platform/actors/development/quick_start/start_web_ide.md
+93-41Lines changed: 93 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,91 +5,143 @@ description: Create your first Actor using the web IDE in Apify Console.
5
5
slug: /actors/development/quick-start/web-ide
6
6
---
7
7
8
+
import Tabs from '@theme/Tabs';
9
+
import TabItem from '@theme/TabItem';
10
+
8
11
# Development in web IDE
9
12
10
13
**Create your first Actor using the web IDE in Apify Console.**
11
14
12
15
---
13
16
14
-
## 1. Create the Actor
17
+
## Create the Actor
18
+
19
+
:::note Prerequisites
20
+
21
+
To use Web IDE, you will need an Apify account. You can [sign-up for a free account](https://console.apify.com/sign-up) on the Apify website.
15
22
16
-
> You will need an Apify account to complete this tutorial. If you don't have one, you can [sign-up for a free account](https://console.apify.com/sign-up) on the Apify website.
23
+
:::
17
24
18
-
After you sign in to [Apify Console](https://console.apify.com), navigate to the [Actors](https://console.apify.com/actors) section on your left panel. Then, click the **Create new** button at the top right corner of the page.
25
+
After you sign in to [Apify Console](https://console.apify.com), navigate to the [**Actors**](https://console.apify.com/actors) section. Then, click the **Develop new** button at the top right corner of the page.
19
26
20
27

21
28
22
-
You will be redirected to a page containing various Actor development templates for popular languages such as JavaScript, TypeScript, and Python. You can choose the template that best suits your technology stack. For demonstration purposes, let's choose "PuppeteerCrawler in JavaScript".
29
+
You will be redirected to a page containing various Actor development templates for popular languages such as `JavaScript`, `TypeScript`, and `Python`. These templates provide boilerplate code and a preconfigured environment tailored to specific use cases. You can choose the template that best suits your technology stack. For demonstration purposes, let's choose **Crawlee + Puppeteer + Chrome**.
23
30
24
31

25
32
26
-
You will be prompted to give your Actor a name and then redirected to your Actor configuration page.
33
+
After choosing the template your actor will be automatically named and you will be redirected to its page.
27
34
28
-
##2. Explore the source code
35
+
###Explore the source code
29
36
30
-
Now it's time to take a peek at the source code. You can see the boilerplate code that uses the [Apify SDK](https://docs.apify.com/sdk/js/) combined with [Crawlee](https://crawlee.dev/), Apify's popular open-source Node.js web scraping library. The code does a recursive crawl of the whole [apify.com](https://apify.com) website.
37
+
The provided boilerplate code utilizes the [Apify SDK](https://docs.apify.com/sdk/js/) combined with [Crawlee](https://crawlee.dev/), Apify's popular open-source Node.js web scraping library. By default the code performs a recursive crawl of the [apify.com](https://apify.com) website, but you can change it to a website of your choosing.
31
38
32
-
> [Crawlee](https://crawlee.dev/) is an open-source Node.js web scraping and browser automation library. <br />
33
-
> It helps you build reliable crawlers. Fast.
39
+
:::info Crawlee
40
+
41
+
[Crawlee](https://crawlee.dev/) is an open-source Node.js library designed for web scraping and browser automation. It helps you build reliable crawlers quickly and efficiently.
42
+
43
+
:::
34
44
35
-
Let's run it! To run your Actor, you need to build it first, so let's press the "Build" button below the source code.
To run your Actor, you need to build it first. Click the **Build** button below the source code to start the build process.
40
51
41
-
After you press the "Build" button, the UI transitions to the "Build" tab, and you can see the progress of the build, including the Docker build log.
52
+
Once the build has been initiated, the UI will transition to the **Last build**tab, displaying the progress of the build and the Docker build log.
42
53
43
54

44
55
45
-
Notice that the UI includes four tabs - (1) Code, (2) Build, (3) Input, and (4) Run. This represents the Actor creation flow where you need first to take the source code and build it. Once you have a build, you give it input which results in an Actor run.
56
+
:::note Actor creation flow
57
+
58
+
The UI includes four tabs:
59
+
60
+
-**Code**
61
+
-**Last build**
62
+
-**Input**
63
+
-**Last Run**
64
+
65
+
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.
66
+
67
+
:::
68
+
69
+
### Run the Actor
46
70
47
-
## 4. Run it
71
+
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**:
48
72
49
-
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 consisting of build, timeout, and memory limit.
73
+
-**Build**
74
+
-**Timeout**
75
+
-**Memory limit**
50
76
51
77

52
78
53
-
You can start an Actor run by pressing the **Start** button at the bottom of the page. Once the run is created, you can view its log and other details, including the **Results**which will shortly start popping up in the output tab. You can always stop the run using the **Abort** button.
79
+
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.
54
80
55
81

56
82
57
-
## 5. Pull it
83
+
### Pull the Actor
84
+
85
+
To continue development locally, you can pull the Actor's source code to your local machine.
For further local development, you can pull the Actor's source code to your local machine. You can get instructions for your Actor on the Actor detail page.
112
+
1. Log in to the Apify platform
60
113
61
-

114
+
```bash
115
+
apify login
116
+
```
62
117
63
-
To pull your Actor, you need to have `apify cli` installed. You can install it using the npm:
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.
92
143
93
-
## 6. Iterate
144
+
To learn more about the Apify platform's features and best practices for Actor development:
94
145
95
-
Now you can get back to the source code and modify the Actor to match your needs. To learn about all the Apify platform features and best practices, continue to the following chapter of this section or visit the [Apify Academy](/academy).
146
+
- Continue to the next chapter of this section for in-depth guidance and examples
147
+
- Visit the [Apify Academy](/academy) to access a comprehensive collection of tutorials, documentation, and learning resources.
0 commit comments