ngx-rocket / generator-ngx-rocket

:rocket: Extensible Angular 14+ enterprise-grade project generator
https://ngx-rocket.github.io/
MIT License
1.53k stars 216 forks source link

Hightlight the value proposition of the starter-kit #37

Closed japf closed 6 years ago

japf commented 7 years ago

I think the current documentation currently lacks explaining the value proposition of the starter-kit compared to going straight with the anguar-cli. In the README, we currently have:

Web project starter kit including modern tools and workflow based on angular-cli, best practices from the community, a scalable base template and a good learning base. Benefits

  • Quickstart a project in seconds and focus on features, not on frameworks or tools
  • Industrial-grade tools, ready for usage in a continuous integration environment and DevOps
  • Scalable architecture with base app template including example components, services and tests

I think it would be a nice addition to clearly explain the advantages of bootstraping a new projet from the starter-kit instead of the angular-cli. Back to the Angular 1.x world, because there was no cli so everyone was looking for a starter-kit to speed up their development. Now that the angular-cli is out, I think we should explain why using a starter-kit still makes a lot of sense.

Ideas?

sinedied commented 7 years ago

That a good idea, but finding the good words for it is a difficult task ^^

The ideas behind the 3 points I wrote initially (not the cleared way to say so, I know...):

Quickstart a project in seconds and focus on features, not on frameworks or tools

=> Provides a ready-to-use environnement with all frameworks/tools needed to start development (= no need to add other libs or tools to begin), including UI framework, i18n and utility libs. Documentation with best practices and coding guides are also provided, along with an interactive documentation system.

Industrial-grade tools, ready for usage in a continuous integration environment and DevOps

=> Linting is improved (+ HTML + SCSS) and stricter than angular-cli, tasks are ready for CI with unit tests and coverage reporting and a PhantomJS runner (vs Chrome and no preconfigured UT reporters for angular-cli). Additional tool for translation workflow is also included.

Scalable architecture with base app template including example components, services and tests.

=> Comprehensive examples for common use-cases are provided, along with best practices, so beginner (and experienced) teams have a base learning ground to properly develop their app.

All of this could be used I think to build a better value proposal, but I agree that the current text is not very clear/attractive vs bare angular-cli. I'm open to suggestions here :smile:

Maybe a straight bare angular-cli vs SK comparison table?

dancancro commented 7 years ago

Hi. Great project.

Is your end goal more to increase the marketshare of this project specifically or to foster convergence of the many starter projects out there? I would be happy to help you with the latter.

sinedied commented 7 years ago

@dancancro As for convergence/extensions plan you should take a look at https://github.com/angular-starter-kit/generator-ngx-app/issues/33

The primary goal is to make a base web/mobile angular stack based on Bootstrap or Ionic 2 (maybe others later), then allow to customize/complete this base with addon generators, as no starters can fit all the needs out there 😀 I can't maintain a starter with all the existing tools/frameworks on my own, but if we split the job we can definitely rationalize the many starters out there, especially when the addon generator feature is done.

sinedied commented 7 years ago

Ok since I'm getting tired to explain on reddit the differences with plain angular-cli, the readme should definitely be updated with some additional info ^^

Here's a copy of what I quickly replied on reddit as a reminder, the form needs to be improved a bit:

sinedied commented 7 years ago

I made a quick readme update on the readme to go along with the new major release, what do you think @japf ?

@dancancro I know it's been a while, but if you're still up to it now that the foundations are ready (multiple targets, UI frameworks and add-on support) I would be glad to work more towards (Angular) starter kits convergence 😉 Do you have any specific thoughts on this?

japf commented 7 years ago

Like it a lot ! I think it greatly showcase the advantages over the bare Angular Cli, great job !

dancancro commented 7 years ago

Hi @sinedied

I like the new docs. Sure, I have some thoughts. And some solutions.


1. Tech Tradeoffs Database

Solution No. 1: If you would like to clarify the advantages/tradeoffs of ngx-rocket wrt angular-cli

Add information about generator-ngx-rocket to this spreadsheet and then produce a complete comparison between it and others. You can begin by filling in [this]() little form and I'll give you comment permission to the spreadsheet.


2. Great Big Example Application

Solution No. 2: If you would like to accelerate starting point convergence

You're not gonna like this one, but...

Work with me. Instead of continuing to develop ngx-rocket separately, help improve my project (made from genius demos built by other people) and JHipster by working on its task queue or other important enhancements, features, documentation or innovations delivered by ngx-rocket. The more consistent and objectively superior a single option is, as measured by its benefits, the more people will invest in it and contribute to it instead of branching off in more and more and more and more and more different directions.

bursauxa commented 6 years ago

Here is my take on this issue (it represents my personal opinion and should not be considered as the project's official stance):

Any and all comments are welcome :open_hands: