ngrx / store

RxJS powered state management for Angular applications, inspired by Redux
MIT License
3.9k stars 311 forks source link

Installation instructions update #249

Closed davidtlee closed 8 years ago

davidtlee commented 8 years ago

Is it possible to update the installation instructions now that Angular 2 is using Webpack instead of SystemJS? I'm guessing it's really straightforward, but since I don't know how Webpack or SystemJS works, it's hard for me to figure out based on looking through the example-app.

Thanks!

jjstreet commented 8 years ago

Im not affiliated with ngrx or anything but I think you might be mistaken about angular2 "using" Webpack.

Angular2 doesn't use SystemJS or Webpack or any builder since Angular2 is the framework that you use to create applications. Which builder (or none at all) you use alongside Angular2 is completely up to you.

I recommend you look at the Webpack cookbook entry in the angular.io site. It has some good information on beginning to use Webpack. Alternatively, you could use one of the many Webpack starters for Angular2, or take a look at the angular-cli project, which uses Webpack as well.

Finally, to use ngrx with angular2 is no different than using any other node library. You install with npm and then import the store and effects modules as described in the how-to. You can ignore the systemJS instructions if you use webpack since webpack-dev-server will inline the node_modules automatically for you.

alexjoverm commented 8 years ago

I'm with @davidtlee on this. Angular 2 has nothing to do with webpack, but nowadays webpack is the most used bundler by far, and Angular CLI uses it. Plus, many people doesn't know webpack, so with a couple of lines in the docs you already save some trouble for someone.

I don't think SystemJS will be used that much, but the installation docs can remain for it as well, since there may be some that use it.

glendaviesnz commented 8 years ago

I just put in a pull request for a possible Readme change to cover this

davidtlee commented 8 years ago

Awesome! Thanks, this is helpful!

On Fri, Oct 14, 2016 at 2:52 PM, Glen Davies notifications@github.com wrote:

I just put in a pull request for a possible Readme change to cover this

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ngrx/store/issues/249#issuecomment-253928587, or mute the thread https://github.com/notifications/unsubscribe-auth/AA0raTZHYEtLw4adzVkBtho31UoBZJtgks5qz_mVgaJpZM4KUMxn .

David Lee Website: tech4good.soe.ucsc.edu Cell: (408) 857-1182

alexjoverm commented 8 years ago

@glendaviesnz seems like we did the same thing in parallel... #252 (though your PR was a bit quicker)

glendaviesnz commented 8 years ago

@alexjoverm - haha - I am not wedded to the additional wording I added - so whichever the project owners think is the best option is fine by me :-)

alexjoverm commented 8 years ago

I see the README.md much better documented. Thanks and good job guys!