-
Notifications
You must be signed in to change notification settings - Fork 61
gsoc 25 week 07 update by Nikhil #331
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
80 changes: 80 additions & 0 deletions
80
src/constants/MarkdownFiles/posts/2025-07-20-gsoc-25-Nikhil-Bhatt-week07.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
--- | ||
title: "GSoC '25 Week 07 Update by Nikhil Bhatt" | ||
excerpt: "Implemented forking of projects in the frontend, backend route for returning project data only, and student descriptions for projects" | ||
category: "DEVELOPER NEWS" | ||
date: "2025-07-20" | ||
slug: "2025-07-20-gsoc-25-nikhilbhatt-week07" | ||
author: "@/constants/MarkdownFiles/authors/nikhil-bhatt.md" | ||
tags: "gsoc25,sugarlabs,week07,nikhilbhatt" | ||
image: "assets/Images/GSOC.png" | ||
--- | ||
|
||
<!-- markdownlint-disable --> | ||
|
||
# Week 07 Progress Report by Nikhil Bhatt | ||
|
||
**Project:** [Git backend for MusicBlocks](https://github.com/benikk/musicblocks-backend) | ||
**Mentors:** [Walter Bender](https://github.com/walterbender), [Sumit Srivastava](https://github.com/sum2it) | ||
**Reporting Period:** 2025-07-13 – 2025-07-20 | ||
|
||
--- | ||
|
||
## This Week's Achievements | ||
|
||
### Backend: Project data end point | ||
|
||
- Created a new backend route that returns project data of projects without forking them `GET/api/github/getProjectData`. | ||
Earlier, when we used to click "Open in Music blocks" in the projects page, a shallow fork of the project (without all the project history) | ||
used to get created, the route helps in only returning the projectData which is loaded to musicblocks allowing students to see first and then | ||
decide whether to fork or not. | ||
|
||
- Custom description for the project - This change allows student to add descriptions to their projects, similar to what they did in the planet page. | ||
|
||
--- | ||
|
||
### Frontend: Forking projects & Student written Description for Projects | ||
|
||
- Fork Button in UI: Users now see a "Fork This Project" button while inside any project. | ||
- It also retains all commit history from the original repository in the fork. | ||
- Allows student to edit the forked projects in their own repo to work further on others projects. | ||
- Students can also enter the description for their projects when creating their projects, also visible in the projects page. | ||
--- | ||
|
||
## Challenges & How I Solved Them | ||
|
||
- **Challenge:** Handling local saved states for identifying projects with their keys. | ||
**Solution:** We are replacing the repoName and its key when a project is forked, discussion on this approach is still in progress. | ||
|
||
- **Challenge:** Managing clear separation between forking and opening a project in Music Blocks. | ||
**Solution:** Created a separate end point which only returns the projectData, no forking initially, will save loading time as well as un-necessary repository creation. | ||
|
||
--- | ||
|
||
## Key Learnings | ||
- Understanding the importance of UX clarity when introducing forking systems. | ||
- How forks inherit full Git commit histories and the implications for educational use-cases, reflective journey in particular. | ||
- Value of allowing students to describe their projects for documentation and self-reflection. | ||
|
||
--- | ||
|
||
## Next Week's Roadmap | ||
- Begin work on downloading and sharing of projects. | ||
- Conceptualise creating pull requests and an option to see them Music Blocks. | ||
- Discuss on working on multiple projects simultaneously. | ||
|
||
|
||
--- | ||
|
||
## Resources & References | ||
|
||
- [MusicBlocks Frontend Repo](https://github.com/sugarlabs/musicblocks) | ||
- [musicblocks-backend](https://github.com/benikk/musicblocks-backend) | ||
- [Octokit REST.js Library](https://github.com/octokit/rest.js) | ||
|
||
--- | ||
|
||
## Acknowledgments | ||
|
||
Thanks again to my mentors and the Sugar Labs community for feedback and support! | ||
Looking forward to next week’s frontend PR features. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At some point, we should transfer this to SugarLabs's org account (and have you as admin).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure!