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.

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

merged 3 commits into from Nov 16, 2016

Conversation

ghost
Copy link

@ghost ghost commented Nov 11, 2016

Added this required step where user have to tell to System loader where Angular Material2 is located.

…ystem loader where Angular Material is located.
@@ -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

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

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.

@jelbourn
Copy link
Member

@amiral84 are you going to make the recommended changes in the PR?

@ghost
Copy link
Author

ghost commented Nov 15, 2016

@jelbourn yes I will make it today as soon as possible.

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please let us know the company's name.

@googlebot googlebot added the cla: no PR author must sign Google's Contributor License Agreement: https://opensource.google.com/docs/cla label Nov 15, 2016
@ghost
Copy link
Author

ghost commented Nov 15, 2016

@jelbourn now it is updated. :)

@ghost
Copy link
Author

ghost commented Nov 15, 2016

@googlebot I signed it!

@googlebot
Copy link

CLAs look good, thanks!

@googlebot googlebot added cla: yes PR author has agreed to Google's Contributor License Agreement and removed cla: no PR author must sign Google's Contributor License Agreement: https://opensource.google.com/docs/cla labels Nov 15, 2016
@@ -33,6 +33,20 @@ import { MaterialModule } from '@angular/material';
export class PizzaPartyAppModule { }
```

## Configuring SystemJS
Copy link
Member

Choose a reason for hiding this comment

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

Can you move this section below ### Additional setup for md-slide-toggleandmd-slider:?

@jelbourn
Copy link
Member

LGTM, thanks!

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker and removed pr: needs review labels Nov 16, 2016
@ghost
Copy link
Author

ghost commented Nov 16, 2016

@jelbourn you're welcome :). Hope this will help many.

@kara kara merged commit 435e0d9 into angular:master Nov 16, 2016
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants