search

tomastrajan / angular-ngrx-material-starter

Angular, NgRx, Angular CLI & Angular Material Starter Project
https://tomastrajan.github.io/angular-ngrx-material-starter
MIT License
2.82k stars 918 forks source link

Architecture Specification #468

Closed ewertonews closed 5 years ago

ewertonews commented 5 years ago

Describe the feature you'd like:

It would nice to have a picture/diagram representing the architecture of the template. What are the modules, components and how they interact with each other and so on. It would help people to better understand the template code.

Other information:

N/A

I would be willing to submit a PR to fix this issue:

[ ] Yes (Assistance is provided if you need help submitting a pull request)
[x] No

jcox86 commented 5 years ago

@ewertonews Have you tried running and exploring though Compodoc against this project? This project has a dev dependency on it. Compodoc works on many Angular projects for what you are describing.

tomastrajan commented 5 years ago

@ewertonews @jcox86 the compodoc was removed as I think it is best to keep starter as lean as possible, besides that it's a great advice and feel free to add it when you use it on your own, maybe we can add note in readme.

I just wanted to reduce complexity of the starter because it became very bloated over the years!