Skip to content

Commit 59ab76d

Browse files
MarkTechsonsr5434
authored andcommitted
docs: update first-app-tutorial introduction (angular#49980)
Add application screenshot (and create the directory to host images for this tutorial). Also, update index.md instructions and complete TODOs/missing content. PR Close angular#49980
1 parent 51d0dd0 commit 59ab76d

File tree

2 files changed

+31
-46
lines changed

2 files changed

+31
-46
lines changed
2.21 MB
Loading
Lines changed: 31 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
# Introduction to Angular tutorial - the First Angular app
22

3-
<div class="callout is-important">
4-
5-
<header>This topic is a work in progress</header>
6-
7-
This topic is a rough draft. Many sections are incomplete and some or all content might change before its final draft.
8-
9-
</div>
10-
113
This tutorial consists of lessons that introduce the Angular concepts you need to know to start coding in Angular.
124

135
If you're just starting out with Angular, completing the lessons in sequence provides the best learning experience, because each lesson builds on the previous lessons.
@@ -22,9 +14,9 @@ For the best experience with this tutorial, review these requirements to make su
2214

2315
<!-- markdownLint-disable MD001 -->
2416

25-
#### Your experience
17+
### Your experience
2618

27-
The lessons in this tutorial assume that you have done the following.
19+
The lessons in this tutorial assume that you have done the following:
2820

2921
1. **Created an HTML web page by editing the HTML directly.**
3022
This tutorial makes references to HTML elements and the Document Object Model (DOM). If these terms are not familiar, review HTML programming before you start this tutorial.
@@ -35,75 +27,69 @@ The lessons in this tutorial assume that you have done the following.
3527
1. **Used command-line instructions to perform tasks on your computer.**
3628
Angular uses the Angular CLI to perform many tasks. This tutorial provides the commands to use and assumes that you know how to open the command line tool or terminal interface in which to use them. If you aren't sure how to use a command line tool or terminal interface, review that before starting this tutorial.
3729

38-
#### Your equipment
30+
### Your equipment
3931

40-
For the best learning experience, do the lessons on your own computer that's running Windows or macOS and connected to the internet.
41-
You can also work through these lessons on the web without installing any software on your computer, by using the StackBlitz examples linked from each lesson.
32+
These lessons can be completed by using a local installation of the Angular tools or by using StackBlitz in a web browser. Local Angular development can be completed on Windows, MacOS or Linux based systems.
4233

43-
Working on your own computer has the advantage of being able to save your work locally for future reference.
44-
If you're working on your own computer, the procedure that follows get your computer ready for the tutorial.
45-
46-
Working in StackBlitz allows you to work through the lessons without loading any software on your own computer.
47-
You can save your work in StackBlitz by using your GitHub account.
48-
To save your StackBlitz lessons, make sure you can access your GitHub account before you start.
34+
Working on your own computer has the advantage of being able to save your work locally for future reference. Working in StackBlitz allows you to work through the lessons without loading any software on your own computer.
4935

5036
## Conceptual preview of your first Angular app
5137

5238
The lessons in this tutorial create a simple Angular app that lists houses for rent and show the details of individual houses.
5339
This app uses features that are common to many Angular apps.
40+
<section class="lightbox">
41+
<img alt="Output of heroes dashboard" src="generated/images/guide/faa/homes-app-landing-page.png">
42+
</section>
5443

55-
\[TODO: add more details and images of the app.\]
56-
57-
## Lesson steps
44+
## Development environment
5845

59-
If you are using your own computer for this tutorial, you must install the required software.
46+
If you plan to complete this tutorial on your local computer, you must install the required software.
6047
If you have already installed some of the required software, you must verify that it is the correct version.
6148

6249
Perform these steps in a command-line tool on the computer you want to use for this tutorial.
6350

64-
<div class="alert is-important">
51+
<section class="alert is-important">
6552

6653
**IMPORTANT:**
6754
If you plan to use StackBlitz to do the lessons, you can proceed to the first lesson.
6855
You don't need to install any software.
6956

70-
</div>
57+
</section>
7158

7259
### Step 1 - Identify the version of `node.js` that Angular requires
60+
<section class="alert is-important">
7361

74-
\[TODO: describe goal of this step in a sentence. \]
62+
**IMPORTANT:**
63+
This step is only required if you have a version of node installed, otherwise, proceed to step 2 below.
7564

76-
In the **Terminal** pane of your IDE:
65+
</section>
7766

78-
1. In your project directory, navigate to the `first-app` directory.
79-
1. \[TODO: describe how to do this in numbered actions.\]
67+
Angular requires an active LTS or maintenance LTS version of Node. Let's confirm your version of `node.js`. For information about specific version requirements, see the engines property in the [package.json file](https://unpkg.com/browse/@angular/core@15.1.5/package.json).
8068

81-
### Step 2 - Install the correct value of `node.js` for Angular
69+
From a **Terminal** window:
70+
1. Run the following command: `node --version`
71+
1. Confirm that the version number displayed meets the requirements.
8272

83-
\[TODO: describe goal of this step in a sentence. \]
73+
### Step 2 - Install the correct version of `node.js` for Angular
8474

85-
In the **Terminal** pane of your IDE:
75+
If you do not have a version of `node.js` installed, please follow the [directions for installation on nodejs.org](https://nodejs.org/en/download/)
8676

87-
1. In your project directory, navigate to the `first-app` directory.
88-
1. \[TODO: describe how to do this in numbered actions.\]
8977

9078
### Step 3 - Install the latest version of Angular
9179

92-
\[TODO: describe goal of this step in a sentence. \]
80+
With `node.js` and `npm` installed, the next step is to install the [Angular CLI](https://angular.io/cli) which provides tooling for effective Angular development.
9381

94-
In the **Terminal** pane of your IDE:
82+
From a **Terminal** window:
9583

96-
1. In your project directory, navigate to the `first-app` directory.
97-
1. \[TODO: describe how to do this in numbered actions.\]
84+
1. Run the following command: `npm install -g @angular/cli`
85+
1. Once the installation completes, the terminal window will display details of the Angular CLI version installed on your local computer.
9886

9987
### Step 4 - Install integrated development environment (IDE)
10088

101-
\[TODO: describe goal of this step in a sentence. \]
102-
103-
In the **Terminal** pane of your IDE:
89+
You are free to use any tool you prefer to build apps with Angular. We recommend the following:
10490

105-
1. In your project directory, navigate to the `first-app` directory.
106-
1. \[TODO: describe how to do this in numbered actions.\]
91+
1. [Visual Studio Code](https://code.visualstudio.com/)
92+
2. As an optional, but recommended step you can further improve your developer experience by installing the [Angular Language Service](https://marketplace.visualstudio.com/items?itemName=Angular.ng-template)
10793

10894
## Lesson review
10995

@@ -117,6 +103,5 @@ In this lesson, you learned about the app that you build in this tutorial and pr
117103

118104
For more information about the topics covered in this lesson, visit:
119105

120-
* \[TODO: Links to related topic.\]
121-
* \[TODO: Links to related topic.\]
122-
* \[TODO: Links to related topic.\]
106+
* [What is Angular](https://angular.io/guide/what-is-angular)
107+
* [Angular CLI Reference](https://angular.io/cli)

0 commit comments

Comments
 (0)