Skip to content

Commit 2d108c2

Browse files
committed
docs(readme): fix a few links
1 parent 2b61a0e commit 2d108c2

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,10 @@ This utilizes all the latest standards, no gulp, no bower, no typings, no manual
5050
- **Angular 4.0.0** :
5151
- Featuring Server-side rendering (Platform-Server (basically Angular Universal, but moved into Angular Core)
5252
- Faster initial paints, SEO (Search-engine optimization w Title/Meta/Link tags), social media link-previews, etc
53-
- i18n - internationalization support (via/ ngx-translate)
53+
- i18n internationalization support (via/ ngx-translate)
5454
- Baked in best-practices (follows Angular style guide)
55-
- Bootstrap4 (with ng2-bootstrap) - (can be rendered on the server!)
55+
- Bootstrap3 (with ngx-bootstrap) - (can be rendered on the server!)
56+
- Can be easily replaced with bootstrap4 (3 is provided for browser support)
5657
- Bootstrap using SCSS / SASS for easy theming / styling!
5758

5859
- **Webpack build system (Webpack 2)**
@@ -74,9 +75,16 @@ This utilizes all the latest standards, no gulp, no bower, no typings, no manual
7475

7576
- **Azure**
7677
- Microsoft Application Insights setup (for MVC & Web API routing)
77-
- Client-side Angular2 Application Insights integration [ coming soon ]
78-
- https://github.com/MarkPieszak/angular-application-insights
79-
78+
- Client-side Angular2 Application Insights integration
79+
- If you're using Azure simply install `npm i -S @markpieszak/ng-application-insights` as a dependencies.
80+
- More information here: - https://github.com/MarkPieszak/angular-application-insights
81+
```typescript
82+
// Add the Module to your imports
83+
ApplicationInsightsModule.forRoot({
84+
instrumentationKey: 'Your-Application-Insights-instrumentationKey'
85+
})
86+
```
87+
8088

8189
> Looking for the older 2.x branch? Go [here](https://github.com/MarkPieszak/aspnetcore-angular2-universal/tree/old-2.x-universal-branch)
8290
@@ -120,8 +128,8 @@ export ASPNETCORE_ENVIRONMENT=Development
120128

121129
- Update to use npm [ngAspnetCoreEngine](https://github.com/angular/universal/pull/682) (still need to tweak a few things there)
122130
- Potractor e2e testing
123-
- Add Azure application insights module (or at least demo how to use it)
124-
- Add Redux back in
131+
- Add Redux back in (maybe?)
132+
- ~~Add Azure application insights module (or at least demo how to use it)~~
125133
- ~~Add i18n support~~
126134
- ~~DONE - Fix old README to match new project~~
127135
- ~~Add AoT compilation~~
@@ -177,15 +185,15 @@ Here we have the *usual suspects* found at the root level.
177185
With Angular Universal, we need to split our applicatoin logic **per platform** so [if we look inside this folder](./Client),
178186
you'll see the 2 root files, that branch the entire logic for browser & server respectively.
179187

180-
- [**Boot-Client.ts**](./Client/boot-client.ts) -
188+
- [**Main.Browser.ts**](./Client/main.browser.ts) -
181189
This file starts up the entire Angular application for the Client/browser platform.
182190

183191
Here we setup a few things, client Angular bootstrapping.
184192

185193
You'll barely need to touch this file, but something to note, this is the file where you would import libraries that you **only** want
186194
being used in the Browser. (Just know that you'd have to provide a mock implementation for the Server when doing that).
187195

188-
- [**Boot-Server.ts**](./Client/boot-server.ts) -
196+
- [**Main-Server.ts**](./Client/main.server.ts) -
189197
This file is where Angular _platform-server_ *serializes* the Angular application itself on the .NET server
190198
within a very quick Node process, and renders it a string. This is what causes that initial fast paint
191199
of the entire application to the Browser, and helps us get all our _SEO_ goodness :sparkles:
@@ -364,7 +372,7 @@ constructor(element: ElementRef, renderer: Renderer) {
364372
Simply comment out the logic within HomeController, and replace `@Html.Raw(ViewData["SpaHtml"])` with just your applications root
365373
AppComponent tag ("app" in our case): `<app></app>`.
366374
367-
> You could also remove any `ifPlatformBrowser/etc` logic, and delete the boot-server, browser-app.module & server-app.module files, just make sure your `boot-client` file points to `app.module`.
375+
> You could also remove any `isPlatformBrowser/etc` logic, and delete the boot-server, browser-app.module & server-app.module files, just make sure your `boot-client` file points to `app.module`.
368376
369377
### How do I have code run only in the Browser?
370378
@@ -382,7 +390,7 @@ better, more abstract ways of dealing with the DOM in Angular (2+) such as using
382390
Yes, of course but there are a few things you need to setup before doing this. First, make sure jQuery
383391
is included in webpack vendor file, and that you have a webpack Plugin setup for it. `new webpack.ProvidePlugin({ $: 'jquery', jQuery: 'jquery' })`
384392
385-
Now, make sure any "plugins" etc that you have, are only included in your `boot-client.ts` file. (ie: `import 'slick-carousel';`)
393+
Now, make sure any "plugins" etc that you have, are only included in your `main.browser.ts` file. (ie: `import 'slick-carousel';`)
386394
In a Component you want to use jQuery, make sure to import it near the top like so:
387395
388396
```typescript

0 commit comments

Comments
 (0)