Create a napkin diagram and architecture

airavata-courses / DCoders

Spring 2022 Project

Apache License 2.0

1 stars 0 forks source link

Create a napkin diagram and architecture #1

Closed vinayakasg18 closed 2 years ago

vinayakasg18 commented 2 years ago

Technical story

Understand the use cases.
Create a basic diagram on the understanding of the use cases.
Each team member to create a napkin diagram
Decide on the final diagram and create a PR to merge to master

vinayakasg18 commented 2 years ago

Meeting Overview, 01/19/2022

As a first meeting, we brainstormed on the project idea to understand the basic need for the first iteration and what all the services required.
Discussion on project strategies and the role of each team member.
How to communicate on GitHub and create stories, issues, and bugs.
Created a wiki page.
Team to come back with the napkin diagram and architecture of the project.

SwetShah commented 2 years ago

Guys, I have created a napkin diagram. Let me know what do you guys think.

Napkin diagram 2

vinayakasg18 commented 2 years ago

Looks good but mostly aligns with the architecture diagram(need to include other technical details though). Think of explaining the project to someone who doesn't have any idea about the technologies in a single diagram.

SwetShah commented 2 years ago

Good suggestion. Let me refactor the same

SwetShah commented 2 years ago

Please find below the refactored diagram

Napkin_2

vinayakasg18 commented 2 years ago

Looks good. But I feel the window could have had some information related to weather. Otherwise, it is a bit difficult to understand.

vinayakasg18 commented 2 years ago

NapKinDiagram2 How about this?.

SwetShah commented 2 years ago

Looks good to me

SwetShah commented 2 years ago

What do you think for the following

Napkin_3

vinayakasg18 commented 2 years ago

Much better. I'm okay with this. @ChaitanyaD20, what do you say?

ChaitanyaD20 commented 2 years ago

Yes, the 2nd (refactored) diagram is better is it conveys meaning in a better way.

vinayakasg18 commented 2 years ago

Once we have finalized the napkin diagram. Please commit to the main branch by following the below commit message template. Commit directly to the main branch allowed only this time since it is not a code change. I will be making changes to restrict what commits go into main. '#issue-id - <issue_name/feature_name>: Short commit message'

ChaitanyaD20 commented 2 years ago

I am also uploading an architecture diagram representing the workflow with initial team responsibilities, kindly have a check and let me know:

UI --> Gateway[Node.js][Chaitanya] <--> User Management [Java] [SQL/Mongo] [Swet]

  Data Source  --> fetches NASA data from AWS cloud [Python] [Vinayak]
          |                                     
          |     
          |                                     
Storage Service  --> DB [Go] [Mongo]
              |
              |
              |
Caching Service (Redis)
              |
              |
              |
 Metadata/Audit (Mongo)

SwetShah commented 2 years ago

Looks great for the initial phase. Might have to do some amendments during the process.

vinayakasg18 commented 2 years ago

Team, We need to push our architecture diagram to GitHub. Let's have a meeting set up to go through again and commit to GitHub.