Collection format mind map design

[Gbahdeyboh]

This issue is created to be the home for discussing the design efforts for the collection format mind map. See postman-open-technologies/gsoc-2023#1

NB: Prospective applicants do not need to worry about this issue, but feel free to contribute to the conversation when we do have them. @mcturco is leading the design efforts for this project and will share any updates we have when it is available.

[sivakumar-77]

Hi Mentor @Gbahdeyboh

I am Sivakumar S, you can call me Siva, and I am a Junior Full Stack web Developer and I am quite proficient in WebScrapying and WebCralwer. It is my First time participating in a GSoC program so I am very interested and excited to work on this project Collection Format : Interactive mind Map.

I am proficient in several key technologies, including Java, NodeJs, HTML, CSS, JavaScript, Rest API, and Docker. With my knowledge and skills in these areas, I am confident in my ability to contribute to this project and deliver high-quality solutions to requirement.

To align with the Contribution Guide , I am excited to introduce myself as a candidate for the selected project for GSoC 2023. I am eager to contribute my skills and knowledge to this project and work collaboratively with the mentors and team members to deliver a high-quality solution. Thank you for considering my application.

Q1) What interests you most about this project?

What interests me most about this project is the opportunity to develop an interactive tool that enables users to map out visually and organize their collections. The project's focus on improving the accessibility and user experience of collection formats is particularly compelling, as it has the potential to make a significant impact on how users interact with and manage their collections and is useful for Non-developers to understand the API without the in-depth knowledge of the api.

Q2)As mentors and project coordinators, how can we get the best out of you?
Regular check-ins and valuable feedback from mentors and coordinators, along with access to relevant resources such as documentation and code samples, will help me stay on the right track and ensure my contributions align with project goals. Additionally, code review and constructive feedback from mentors will ensure my code adheres to best practices of high quality.

Q3) Is there anything that you’ll be studying or working on while working alongside us?
I plan to improve my skills in frontend using React and vis.js to visualise the data in UI and build a good interactive UI for the end users and to get deep knowledge in the Data Visualization.

Q4) We'd love to hear a bit on your work preferences, e.g. how you keep yourself organized, what tools you use, etc?
I keep myself organized by splitting the tasks based on the priority and the time required to finish to task. For project management, I use Zoho Projects to keep track of my progress and I make sure to communicate regularly with my team members and I will make a point to show my progress to my mentor regularly and follow their valuable feedback. By doing so, I can ensure that my work is meeting the project's goals and that any necessary adjustments can be made in a timely manner.

Q5)Once you’ve selected a project from the ideas section, please suggest a weekly schedule with clear milestones and deliverables around it. Alternatively, if you want to propose your own idea then please include outline, goals, and a well-defined weekly schedule with clear milestones and deliverables.

My Initial Approach:
From the day when I know about this project I am learning d3.js and I find some more library for visualising the data like vis.js, p5.js and three.js. And I gone through the pros and corns of each library I decided to go with d3.js because it give more control to the data and DOM.

Then I Find some mindmap projects using d3.js repo to see output here

For MindMap, form the Collection JSON format we need to make tree structure with hierarchy in horizontal direction.

Below is a rough weekly schedule but it can be changed based on feedback and discussion.

Week 1-2: (choosing proper library and Design)
I will choose the best library for visualising data and the create design how to validate the Collection JSON Format with JSON Schema choose what schema validator to like and deep-dive into JSON Schema then the Sample UI,what are the technology to for frontend, to decide that using React, Angular or Using Plain HTML,CSS and JavaScript and the Project Structure.
Milestone: Submit a report to the mentors outlining the findings and the proposed approach for the project.

Week 3-4: (Implementing Design and Basic Prototype)
The approved design will be implemented with basic Prototype UI with simple css and make sure the code logic is working as intended with all collections Format, test the code logic is robust and handle errors in JSON Validation and In UI properly when improper collections format type given. I will make that the functionality of the code will be proper for our project.

Milestone: Submit the prototype to the mentors for review and feedback.

Week 5-6:(Create Interactive UI and Testing)
Approved prototype UI will be enhance with bootstrap for css and if icon need I will use fontawesome and then find testing with different use cases with multiple collections format I will ensure that the function of the code is working properly as intended.

Milestone: Submit updated code and interface for review by the mentors.

Week 7-8: (Further Testing and Documentation)
Conduct multiple testing with different use cases and make the document and guides for the users and developers to understand clearly how to use it and how it works.

Milestone: Submit final code, documentation, and guides to the mentors for final review and approval.

Looking forward to hear feedback from your side about the approach.

cc.jansche

[Gbahdeyboh]

Hi @siva-kumar-s.

Thank you for your interest in this project and for taking the time to introduce yourself and highlight your relevant experiences. It's interesting to see that you're already researching on and learning about visualization tools that'll be appropriate for this project.

In the meantime, you can start working on your final application. I'll be happy to take a look and give feedback when you need them.

Cheers,
~Debo.

[yashm277]

@Gbahdeyboh what is meant by the design efforts for the collection format mind map ?
Would you like me to describe what I would visualise the mindmap to be like ?
Also am I expected to put my proposal on here like @siva-kumar-s or can we submit that privately to you for feedback.
I think that I have completed both the qualifying tasks for this idea. Please do let me know if there is anything else that I can/ should do. I have started exploring different ways in which this mindmap can be made.
Also I would be grateful if you could provide an alternate method of communication as it will become easier to take feedack !
Thanks,
Yash

[sivakumar-77]

Hi @siva-kumar-s.

Thank you for your interest in this project and for taking the time to introduce yourself and highlight your relevant experiences. It's interesting to see that you're already researching on and learning about visualization tools that'll be appropriate for this project.

In the meantime, you can start working on your final application. I'll be happy to take a look and give feedback when you need them.

Cheers,
~Debo.

@Gbahdeyboh

Thank you for reaching out to me and providing your warm welcome. I am excited to be a part of this project and to have the opportunity to learn and grow along with the team.

I appreciate your guidance regarding the next steps, and I look forward to sharing my progress on the final application with you. Your feedback and suggestions would be valuable well really helping me to improve my work.

Once again, thank you for this opportunity, and I look forward to working with you and the team.

Best Regards,
~Siva

[Gbahdeyboh]

Hi @yashm277.

You do not have to worry too much about this specific issue for now(I updated the issue description). Your proposals are not meant to be submitted here. Before submitting your final proposal, if you would like me to take a look, you can out it in a Google Doc, so I can provide feedback.

For communication, his github issue or under this post on our community forum will be a great place to reach me. Let me know if you have further questions!