Adding some guidelines

[growms]

Hello,

Thank you a lot for your good work this repository is really awesome. However it is grouping a lot of third parties and I think it could be very valuable to have a section somewhere about the convention you have followed (what about these sharp prefixed variables ?) and maybe a small tutorial to how to add basic features the right way (ng components, basic model). I mean, I doubt everybody knows about each of the technologies inside this project from start. For example during my first digging, my questions was, how do I add an angular component in "components", do I have to use nx? or ng? ah ok, but then do I have something to do about storybook ? But now I have to pull some todos.. How Should add the model ? is it pal.js doing its stuff or do I have to run additional command ? Well, you see what I mean. It was pretty discouraging. Of course the documentation of each product is helping, but a small introduction of how to do the basic things could be very helpful I think and a tutorial is playful. The project is great and imo is very able to help a lot of small teams, freelancers, etc. to build new products with limited knowledge of full stack architecture.

Thanks again for the good work !

[ZenSoftware]

@growns

Hi there!
Yes, I totally agree. It would definitely be useful to add some getting started docs. I have spent most of my time documenting the core API with JSDoc, but have spent no time at all on tutorials and a proper getting started guide. I have been relying on others to have a small amount of experience using Nx, Nest and Angular due to the frontend as being just a typical Angular app, and the backend as just being a typical Nest app. Though, I too am always looking for good documentation when picking any new technology. I agree that this needs to be addressed.

I'm glad you have found value in the starter kit. I'll chalk this up as a todo.