Skip to content

Commit 7b43a7e

Browse files
authored
docs: simplify icp new command and unify fullstack spelling (#563)
Replace three explicit --define flags with --silent in quickstart and tutorial, rename project from my-project to hello-icp, and change full-stack to fullstack throughout the docs.
1 parent d1c51c5 commit 7b43a7e

4 files changed

Lines changed: 15 additions & 20 deletions

File tree

docs/guides/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The network launcher downloads automatically on first use. If it fails:
163163

164164
## Next Steps
165165

166-
- [Quickstart](../quickstart.md) — Deploy a full-stack app in under 5 minutes
166+
- [Quickstart](../quickstart.md) — Deploy a fullstack app in under 5 minutes
167167
- [Tutorial](../tutorial.md) — Understand each step in detail
168168
- [Local Development](local-development.md) — Day-to-day workflow
169169

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Build and deploy applications on the [Internet Computer](https://internetcompute
77

88
## Start Here
99

10-
- **[Quickstart](quickstart.md)** — Deploy a full-stack app in under 5 minutes
10+
- **[Quickstart](quickstart.md)** — Deploy a fullstack app in under 5 minutes
1111
- **[Tutorial](tutorial.md)** — Deploy your first app step by step
1212

1313
## Guides

docs/quickstart.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: Quickstart
3-
description: Install icp-cli and deploy a full-stack Internet Computer app to a local network in under 5 minutes.
3+
description: Install icp-cli and deploy a fullstack Internet Computer app to a local network in under 5 minutes.
44
---
55

6-
Deploy a full-stack app to a local network in under 5 minutes.
6+
Deploy a fullstack app to a local network in under 5 minutes.
77

88
**Prerequisites:** [Node.js](https://nodejs.org/) (LTS) is required for the installation commands below.
99

@@ -25,10 +25,7 @@ npm install -g ic-mops
2525

2626
```bash
2727
# 1. Create a new project with Motoko backend + React frontend
28-
icp new my-project --subfolder hello-world \
29-
--define backend_type=motoko \
30-
--define frontend_type=react \
31-
--define network_type=Default && cd my-project
28+
icp new hello-icp --subfolder hello-world --silent && cd hello-icp
3229

3330
# 2. Start a local network (runs in background)
3431
icp network start -d

docs/tutorial.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Tutorial
3-
description: Step-by-step walkthrough of deploying a full-stack Motoko and React app on the Internet Computer.
3+
description: Step-by-step walkthrough of deploying a fullstack Motoko and React app on the Internet Computer.
44
---
55

6-
This tutorial walks through deploying a full-stack app on the Internet Computer, explaining each step along the way.
6+
This tutorial walks through deploying a fullstack app on the Internet Computer, explaining each step along the way.
77

8-
> **Already did the Quickstart?** This tutorial covers the same steps with detailed explanations. The Quickstart used `--define` flags to skip the interactive prompts — here you'll see what those prompts are and what they mean.
8+
> **Already did the Quickstart?** This tutorial covers the same steps with detailed explanations. The Quickstart used `--silent` to skip the interactive prompts — here you'll see what those prompts are and what they mean.
99
1010
## What is a Canister?
1111

@@ -49,31 +49,29 @@ mops --version
4949
## Create a Project
5050

5151
```bash
52-
icp new my-project
52+
icp new hello-icp
5353
```
5454

5555
You'll see three prompts:
5656

57-
**1. Template selection** — Choose `hello-world` for a full-stack app with backend and frontend.
57+
**1. Template selection** — Choose `hello-world` for a fullstack app with backend and frontend.
5858

5959
**2. Backend language** — Choose `motoko` (or `rust` if you prefer).
6060

6161
**3. Network type** — Choose `Default` for native local networks. On Windows, Docker is always used regardless of this setting.
6262

63-
> **Tip:** The Quickstart skipped these prompts using `--define` flags:
63+
> **Tip:** The Quickstart skipped these prompts using `--silent`, which applies the template's default values:
6464
> ```bash
65-
> icp new my-project --subfolder hello-world \
66-
> --define backend_type=motoko \
67-
> --define frontend_type=react \
68-
> --define network_type=Default
65+
> icp new hello-icp --subfolder hello-world --silent && cd hello-icp
6966
> ```
67+
> To override a default, add `--define <placeholder>=<value>` (for example, `--define backend_type=rust`).
7068
7169
Templates are fetched from the [icp-cli-templates](https://github.com/dfinity/icp-cli-templates) repository by default. You can also [create your own templates](guides/creating-templates.md).
7270
7371
Enter the project directory:
7472
7573
```bash
76-
cd my-project
74+
cd hello-icp
7775
```
7876
7977
Your project contains:
@@ -181,7 +179,7 @@ icp network stop
181179

182180
## Next Steps
183181

184-
You've deployed a full-stack app on the Internet Computer! Continue your journey:
182+
You've deployed a fullstack app on the Internet Computer! Continue your journey:
185183

186184
- [Local Development](guides/local-development.md) — Learn the day-to-day development workflow
187185
- [Deploying to Mainnet](guides/deploying-to-mainnet.md) — Go live on the Internet Computer

0 commit comments

Comments
 (0)