Need an architectural and systems design diagram for the freeCodeCamp classroom project
lloydchang opened this issue · 10 comments
Describe the bug
Need an architectural and systems design diagram for the freeCodeCamp classroom project
To Reproduce
Steps to reproduce the behavior:
- Go to https://github.com/freeCodeCamp/classroom/
- Read https://github.com/freeCodeCamp/classroom/#readme
- Documentation references source code, but I don't see any architectural or system design diagrams
- I could use an architectural and system design diagram based on the steps described in https://bit.ly/SystemDesignInterview
Expected behavior
An architectural and system design diagram hosted at https://excalidraw.com/ based on the steps described in https://bit.ly/SystemDesignInterview would be helpful to mentors like me.
Additional context
I am mentoring students working on freeCodeCamp/classroom and I am not understanding the architectural and system design of freeCodeCamp/classroom by reading https://github.com/freeCodeCamp/classroom/#readme — without diving deeper into the codebase.
HI @lloydchang, I'm glad you pointed out the lack of documentation for a system design diagram. Thanks for providing the resources to create such a diagram. As the project maintainer, I'll start working on this, or if one of your mentees is already planning to work on it, I'm happy to answer questions.
@utsab Thank you for being happy to answer questions!
Our CodeDay Labs student @Komal914 is interested in working on this issue.
Context: @Komal914 wrote in CodeDay Labs Slack:
I would be happy to give this issue a try! I have never worked to create an architecture diagram for codebases, so I think it would be a great learning opportunity for me 😊
Hi @utsab
Cc @GuillermoFloresV @ngillux @Komal914 @theGaryLarson @sijin-raj
Question: Publicly, do you publish a prioritized list of GitHub issues for contributors work on?
Our CodeDay Labs student @theGaryLarson is having a hard time finding direction on what to work on within fcc/classroom repo.
Thank you!
Hi! I will be happy to work on this issue with @lloydchang and @ngillux :)
HI @lloydchang -- We have an internal list of priorities which we have not yet translated into formal github issues. I'll try to create a few more public issues by next week. In the meantime, I assigned Issue #166 to @theGaryLarson.
Hi @utsab, I am not sure exactly what the requirements are for this design. Here is the latest version of this design:
lgtm
🚢 🇮🇹