Skip to content

Added required step into GETTING_STARTED.md file that is telling to S… #1827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from Nov 16, 2016
Merged

Added required step into GETTING_STARTED.md file that is telling to S… #1827

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2cf0e2e
Added required step into GETTING_STARTED.md file that is telling to S…
amiral84 Nov 11, 2016
2c4aabc
Fixed Configuring SystemJS section.
amiral84 Nov 15, 2016
cd35992
Moved Configuring SystemJS section below Addition setup for md-slide-…
amiral84 Nov 16, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,34 @@ import { MaterialModule } from '@angular/material';
export class PizzaPartyAppModule { }
```

## Tell to System loader where Angular Material is located
This is **required** step. You need to tell to system loader where angular material is located otherwise
Copy link
Member

@jelbourn jelbourn Nov 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Configuring SystemJS is only necessary if you're using SystemJS. If you're using Webpack (such as with angular-cli) or something like Browserify, RequireJS etc., this isn't necessary.

I'm okay with adding something on SystemJS since the angular quickstart uses it, but it should be further down (since not all projects use it). I'd put it as something like:

## Configuring SystemJS
If your project is using SystemJS for module loading, you will need to add `@angular/material` to the SystemJS configuration:
System.config({
  // existing configuration options
  map: {
    ...,
    '@angular/material': 'npm:@angular/material/material.umd.js'
  }
});

Copy link
Author

@ghost ghost Nov 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jelbourn Thank you. I think that would be a good addition to getting started file, because there are lots of beginners who would use Systemjs with their Angular 2 application. That is also good description that you have added in code below. So let's go with it.

material2 can't be loaded.

```js
System.config({
defaultJSExtensions: true,
paths: {
'npm:': './'
},
map: {
app: 'app',

'@angular/core': 'npm:@angular/core/bundles/core.umd.js',
'@angular/common': 'npm:@angular/common/bundles/common.umd.js',
'@angular/compiler': 'npm:@angular/compiler/bundles/compiler.umd.js',
'@angular/platform-browser': 'npm:@angular/platform-browser/bundles/platform-browser.umd.js',
'@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic/bundles/platform-browser-dynamic.umd.js',
'@angular/http': 'npm:@angular/http/bundles/http.umd.js',
'@angular/router': 'npm:@angular/router/bundles/router.umd.js',
'@angular/forms': 'npm:@angular/forms/bundles/forms.umd.js',
'@angular/material': 'npm:@angular/material/material.umd.js', //Add this line

'rxjs': 'npm:rxjs'
}
});
```

## Include the core and theme styles:
This is **required** to apply all of the core and theme styles to your application. You can either
use a pre-built theme, or define your own custom theme.
Expand Down