Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add read me files for every system design solution #16

Open
IAmPramod opened this issue Jun 6, 2020 · 5 comments
Open

Add read me files for every system design solution #16

IAmPramod opened this issue Jun 6, 2020 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@IAmPramod
Copy link

@npathai I would recommend adding read me files to each use case. It would help readers understand code and flow of solution,

@npathai
Copy link
Owner

npathai commented Jun 6, 2020

@IAmPramod Yes I am working on it. If you notice I added proper instructions in README.md related to repository information and how to start the service. Just started, things will get organized slowly. Thanks for the active input!

@npathai
Copy link
Owner

npathai commented Jun 6, 2020

Because the solution for URL service is still evolving, I will be adding hand drawn sketches, and once the solution has reached maturity, I can create a proper diagram and add it.
Thoughts @IAmPramod ?

@npathai npathai added the documentation Improvements or additions to documentation label Jun 6, 2020
@IAmPramod
Copy link
Author

@npathai Yes that makes sense! I was looking at the Id generator code and if it will have flow diagram along with code, it will be much easier to understand.
Yes, I agree with you that once the solution reaches maturity, documentation will also become structured and much more informative.

Also, thanks for this wonderful initiative

@npathai
Copy link
Owner

npathai commented Jun 6, 2020

@IAmPramod I can understand your confusion. Naming conventions are something I am actively thinking about right now. I am stuck somewhere between Anemic domain model and Domain Driven Design. That's why namings are not consistent.
But I guess that's why this repository exists. Get first hand experience with building microservices systems and do the hard things.

References:
Anemic Domain Model vs Domain Driven Design

@npathai
Copy link
Owner

npathai commented Jun 6, 2020

Maybe I can add a quick sketch in a few minutes so that it becomes easier for you to follow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants