Skip to content

Commit 671b7b1

Browse files
docs: Improve Quick Start flow
1 parent ca23f97 commit 671b7b1

File tree

3 files changed

+47
-44
lines changed

3 files changed

+47
-44
lines changed

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,63 @@
11
---
22
title: Quick start
33
sidebar_position: 1
4-
description: Create your first Actor using the Apify Console IDE or locally.
4+
description: Create your first Actor using the Apify Web IDE or locally in your IDE.
55
slug: /actors/development/quick-start
66
---
77

8+
import Card from "@site/src/components/Card";
9+
import CardGrid from "@site/src/components/CardGrid";
10+
811
# Development: Quick start
912

10-
**Create your first Actor using the Apify Console IDE or locally.**
13+
**Create your first Actor using the Apify Web IDE or locally in your IDE.**
1114

1215
---
1316

14-
:::note
17+
:::info
1518

1619
Before you start building your own Actor, try out a couple of existing Actors from [Apify Store](https://apify.com/store). See the [Running Actors](../../running/index.md) section for more information on running existing Actors.
1720

1821
:::
1922

20-
## Language
23+
## Technology Stack
2124

2225
Any code that can run inside of a Docker container can be turned into Apify [Actor](../../index.mdx). This gives you freedom in choosing your technical stack, including programming language and technologies.
2326

2427
But to fully benefit from running on top of the Apify platform, we recommend you choose either JavaScript/Node.js or Python, where Apify provides first-level support regarding its SDK, API clients, and learning materials.
2528

26-
For these languages, you can also choose from many code templates that help you to kickstart your project quickly:
29+
For these languages, you can also [choose from many code templates](https://apify.com/templates) that help you to kickstart your project quickly:
2730

2831
<a href="https://apify.com/templates" target="_blank">
2932
<img src={require("./images/templates.png").default} width="70%" />
3033
</a>
3134

32-
## [](#local-development)Local development
35+
## Development Paths
3336

34-
You can create Actor in two ways:
37+
You can develop Actor in two ways:
3538

36-
- Using the **Web IDE** in [Apify Console](https://console.apify.com). This is the fastest way to kick-start your Actor development and try out the Apify platform.
37-
- Develop your Actor **locally** and only deploy to the Apify platform when it is production ready. This way, you benefit from your local setup for a better development and debugging experience. After you are done with the development, you can easily [deploy](./deployment) your Actor to Apify platform.
39+
### Option 1: local Development
3840

39-
Now, let's start with:
41+
Develop your Actor locally in your IDE and only deploy to the Apify platform when it is production ready.
4042

41-
import Card from "@site/src/components/Card";
42-
import CardGrid from "@site/src/components/CardGrid";
43+
This way, you benefit from your local setup for a better development and debugging experience. After you are done with the development, you can easily [deploy](./deployment) your Actor to Apify platform.
4344

4445
<CardGrid>
4546
<Card
46-
title="Apify Console web IDE"
47-
to="/platform/actors/development/quick-start/web-ide"
47+
title="Start Locally in Your IDE"
48+
to="/platform/actors/development/quick-start/locally"
4849
/>
50+
</CardGrid>
51+
52+
### Option 2: Web IDE
53+
54+
Using the Web IDE in [Apify Console](https://console.apify.com).
55+
56+
This is the fastest way to kick-start your Actor development and try out the Apify platform.
57+
58+
<CardGrid>
4959
<Card
50-
title="Locally on your machine"
51-
to="/platform/actors/development/quick-start/locally"
60+
title="Start in Apify Web IDE"
61+
to="/platform/actors/development/quick-start/web-ide"
5262
/>
5363
</CardGrid>

sources/platform/actors/development/quick_start/start_locally.md

Lines changed: 20 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,54 +9,47 @@ slug: /actors/development/quick-start/locally
99

1010
---
1111

12-
:::info Prerequisites
12+
## What you'll learn
1313

14-
You need to have [Node.js](https://nodejs.org/en/) version 16 or higher with `npm` installed on your computer.
14+
- tbd
1515

16-
:::
17-
18-
## Install Apify CLI
19-
20-
### MacOS/Linux
21-
22-
You can install the Apify CLI via the [Homebrew package manager](https://brew.sh/).
23-
24-
```bash
25-
brew install apify-cli
26-
```
27-
28-
### Other platforms
2916

30-
Use [NPM](https://www.npmjs.com/) to install the Apify CLI.
17+
## Prerequisites
3118

32-
```bash
33-
npm -g install apify-cli
34-
```
19+
- [Node.js](https://nodejs.org/en/) version 16 or higher with `npm` installed on your computer.
20+
- The [Apify CLI](/cli/docs/installation) installed.
21+
- Optional: If you want to deploy your Actor to the Apify platform, you need to [sign in](https://console.apify.com/sign-in).
3522

36-
Visit [Apify CLI documentation](https://docs.apify.com/cli/) for more information regarding installation and advanced usage.
23+
---
3724

38-
## Create your Actor
25+
## Step 1: Create your Actor
3926

40-
To create a new Actor, use the following command:
27+
Use Apify CLI to create a new Actor using the following command:
4128

4229
```bash
4330
apify create
4431
```
4532

46-
The CLI will prompt you to:
33+
The Apify CLI will prompt you to:
4734

4835
1. _Name your Actor_: Enter a descriptive name for your Actor, such as `your-actor-name`
4936
1. _Choose a programming language_: Select the language you want to use for your Actor (JavaScript, TypeScript, or Python).
5037
1. _Select a development template_: Choose a template from the list of available options.
5138

52-
After selecting the template, the CLI will:
39+
:::info
5340

54-
- Create a `your-actor-name` directory with the boilerplate code.
55-
- Install all project dependencies
41+
If you’re unsure which template to use, browse the [full list of templates]((https://apify.com/templates)) with descriptions to find the best fit for your Actor.
42+
43+
:::
5644

5745
![Creation](./images/actor-create.gif)
5846

59-
Navigate to the newly created Actor directory:
47+
After selecting the template, the Apify CLI will:
48+
49+
- Create a `your-actor-name` directory with the boilerplate code.
50+
- Install all project dependencies
51+
52+
Now, you can navigate to the newly created Actor directory:
6053

6154
```bash
6255
cd your-actor-name

0 commit comments

Comments
 (0)