Skip to content

Commit 76e7f4c

Browse files
author
aklukas
committed
chore: update the read me
1 parent 0d9a40c commit 76e7f4c

File tree

3 files changed

+24
-16
lines changed

3 files changed

+24
-16
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
# IDE - VSCode
2121
.vscode/*
22-
!.vscode/settings.json
22+
.vscode/settings.json
2323
!.vscode/tasks.json
2424
!.vscode/launch.json
2525
!.vscode/extensions.json

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ We are going to use the Angular CLI and NRWL Extensions extensively in the works
44

55
Follow the steps below to get started!
66

7+
> NOTE: If you start from the `01-getting-started` branch, the workspace and app is already generated with the correct npm scope set.
8+
79
## The Stack
810

911
### NRWL Workspace
@@ -33,39 +35,45 @@ After you have installed the Angular CLI, install `@nrwl/schematics`.
3335
npm install -g @nrwl/schematics
3436
```
3537

36-
After installing, if you want to create a new Nx workspace, you can by running:
38+
After installing, if you want to create a new Nx workspace with an application, you can by running:
3739

3840
```
39-
npx create-nx-workspace angular-core-workshop
41+
create-nx-workspace angular-core-workshop --preset=empty --cli=angular --npmScope=workshop
4042
```
4143

42-
> NOTE: refer to https://nx.dev/web/getting-started/getting-started on how to get up and running quickly with an Nx workspace.
44+
> NOTE: because the @nrwl/schematics have been installed the above command works, if you have issues with this command not working properly or would rather not install the Nrwl shcematics globally please refer to https://nx.dev/web/getting-started/getting-started for further instruction.
45+
46+
After the workspace is created you will need to cd into the app directory `cd angular-core-workshop` and install the Nrwl Angular schematic:
4347

44-
**NOTE: If you start from the `01-getting-started` branch, the above command was already ran and was used to generate the starting respository.**
48+
```
49+
ng add @nrwl/angular
50+
```
4551

4652
The next step is to generate an app in your workspace. Do so by running:
4753

4854
```
49-
ng generate app dashboard
55+
ng generate @nrwl/angular:application dashboard
5056
```
5157

5258
You'll then be prompted to answer a few setup questions. Run the following for each question:
5359

60+
`Which stylesheet format would you like to use?` SASS(.scss)
5461

55-
` In which directory should the application be generated? ` apps
62+
`Would you like to configure routing for this application?` y
5663

57-
` Would you like to add Angular routing?` y
64+
Lastly, please install the npm dependencies by running:
5865

59-
` Which stylesheet format would you like to use?` y
66+
```
67+
npm install
68+
```
69+
Then run the application:
6070

61-
` Which Unit Test Runner would you like to use for the application? ` Karma
71+
```
72+
npm run start
73+
```
6274

63-
` Which E2E Test Runner would you like to use for the application? ` Protractor
75+
Navigate to `localhost:4200` and you should see this:
6476

65-
` Which tags would you like to add to the application? (used for linting)`
77+
![](RESOURCES/assets/localhost-4200.png)
6678

67-
Lastly, please install the npm dependencies by running:
68-
```
69-
npm install
70-
```
7179
You are good to go!

RESOURCES/assets/localhost-4200.png

213 KB
Loading

0 commit comments

Comments
 (0)