React-redux-universal-hot-example: This repo needs to provide "long and clear" comments

[furkanedu]

Hey eveyone, its been more than 1 week, I am still trying to read this repo's code 7/24 . I am checking modules on google about how they work (for instance piping, http-proxy, multireducer etc.).

But I still can not think this repository will make sense at the end of the day and I am afraid I ll only have lost time reading the source code. There is almost no comments at any file. Am I the only one who does find this repo's code difficult to understand ?

Is what I am doing worth spending time ? I really can not understand how somebody can take the time to do what I am doing. But the thing is , I don ' t even know if what I ll learn is going to help me or not. For instance multireducer package is not being developed anymore, understanding this repo will put nothing useful to my future development goals.

Please show me a way to follow about how to read through projects like this ! I can not call this time-killing process as hacking. By the way It would definetely be great if there were clear long comments explaining what these methods, files etc. do.

[tearsofphoenix]

comment on some files: #1031
AFAIK, there's no need to dive into most of npm packages if you want to understand the project.
those steps may help:

1. understand each folder: why we split files into those folders? what are the functions of each part?
   2.try to add or modify a Component, know the view;
   3.try to add or modify an api, to know the communication path from client to server;
   4.Ignore webpack config files, ignore middleware & some other basic things. Just focus on the component and your own logic.
2. If you have time, learn webpack config & redux or dig into npm packages.
3. go through the issues list, discuss on discord channel.

[furkanedu]

Thank you. It s been really nice to hear your advices.

[hengbenkeji]

I came across this starter 4 months ago, and I cannot write a single line of code ever since, even I have been a programmer for almost 20 years.
Good bye, this so called best practice. It sucks.

[medfreeman]

This sure is a different approach to building a website / app.
There's a lot of new elements to learn, it's not easy, but i don't see how this sucks, perhaps it's too different from what you've seen in the past. Farewell

[jaraquistain]

I don't think that this issue thread is particularly constructive. If @furkanedu has specific questions they can be asked and answered but there's no need to bash on the boilerplate as a whole. If anyone is having trouble there are lots of people around to help but to make such broad claims about the quality of the app architecture is demonstrably incorrect. As a counterpoint to @sdruipeng, I've been a programmer for only about 5 years and I was able to use this boilerplate to start off an app that has been a blast to work on and is scaling extremely well as it grows in complexity and size. There are parts of that I rewrote and parts of it that I left out, but I appreciated that it have everything you need to get going.

[furkanedu]

@jaraquistain thanks for taking the time to write. Laravel for instance is full of comments, I am aware of the fact that it has a larger domain of resources to provide more qualified code in terms of being declarative with useful comments.

I don't think it is difficult to provide long comments for those who are trying to hack this repo. If everybody does the same thing, trying to understand every piece of code by themselves, that is a waste of time. Instead, such a popular repo should provide a better documentation or source code with clear comments.

[jaraquistain]

@furkanedu I fully agree with you that more commenting would make everything easier to learn. I was more commenting on the direction the thread had taken independent of its original intent. The issue should definitely stay open, I was just trying to maybe steer the discussion back on course.