PLANNING ISSUE : Spectral Workbench Capture

[sidntrivedi012]

Planning issue for the roadmap to completing the Spectral Workbench Capture project.

The major tasks to be implemented are as follow:

• Refactoring and Integration
• Testing
• Consolidation and Testing of API for search, matching, etc.
• Making an npm module
• Development of React app around basic ui modules .

However, I will also be dividing these major tasks into subtasks in order to make the tracking of progress easy.

@jywarren @harshithpabbati Please have a look at this and suggest as to what more should I add and how to start the work further. 🙂

[welcome]

Thanks for opening your first issue here! Please follow the issue template to help us help you 👍🎉😄
If you have screenshots to share demonstrating the issue, that's really helpful! 📸 You can make a gif too!

[SidharthBansal]

Thanks @sidntrivedi012 for opening up a planning issue. It will be great if you can break this issues so that we can introduce modularity and fix things in baby steps.

[SidharthBansal]

Please add appropriate labels like gsoc etc.

[sidntrivedi012]

@SidharthBansal I think I don't have the access to add labels. The option to add labels is not popping up.

[harshithpabbati]

Mmm wait let @jywarren add you to the collaborator. So that you will have access to add labels.

[sidntrivedi012]

Sure. @harshithpabbati 👍

[Dhiraj240]

@sidntrivedi012 Have you thought of sub-dividing the above tasks? The coding period is near and as per your proposal work on dividing "Refactoring and Integration" task, so that you can start efficiently.

[jywarren]

I've added you all as collaborators! And, I hope this makes sense but I protected the main branch. Let's be sure to get reviews from me for at least the first few merges to main as we get used to the workflow. Sound good? Thanks all!

[jywarren]

also noting publiclab/plots2#5794 as we get organized!

[starkblaze01]

I've added you all as collaborators! And, I hope this makes sense but I protected the main branch. Let's be sure to get reviews from me for at least the first few merges to main as we get used to the workflow. Sound good? Thanks all!

Yeah sure @jywarren .
And, I guess Cross Domain Session in production is working fine with SWB PR being merged?

[jywarren]

I wanted to note that we could do some more granular task listing here. Maybe:

• resolving basic bugs with current local capture (starting with Error in capture demo #95)
• publishing gh-pages demo of capture working!
• starting a new branch where the /examples/capture/capture.js code is compiled in https://github.com/publiclab/spectral-workbench.js/tree/main/src, in a file called SpectralWorkbench.Capture.js, and saved to /dist/ alongside other compiled files
• pointing the demo at the new /dist/ compiled code
• ensuring it works in gh-pages
• starting to chop up the code in SpectralWorkbench.Capture.js into sub-files, using the require() method (I recommend this post! https://ponyfoo.com/articles/modular-design-thinking) starting with just one sub-file and confirming that the demo works
• repeating to logically break up the big file into smaller chunks, like has been done with existing code! Aim for <100 lines per file and "one purpose per file" roughly

This is a good bit! What do you think???

[sidntrivedi012]

Sure @jywarren. This will be really helpful. Thanks a ton. 🎉

[starkblaze01]

I wanted to note that we could do some more granular task listing here. Maybe:

• resolving basic bugs with current local capture (starting with Error in capture demo #95)
• publishing gh-pages demo of capture working!
• starting a new branch where the /examples/capture/capture.js code is compiled in https://github.com/publiclab/spectral-workbench.js/tree/main/src, in a file called SpectralWorkbench.Capture.js, and saved to /dist/ alongside other compiled files
• pointing the demo at the new /dist/ compiled code
• ensuring it works in gh-pages
• starting to chop up the code in SpectralWorkbench.Capture.js into sub-files, using the require() method (I recommend this post! https://ponyfoo.com/articles/modular-design-thinking) starting with just one sub-file and confirming that the demo works
• repeating to logically break up the big file into smaller chunks, like has been done with existing code! Aim for <100 lines per file and "one purpose per file" roughly

This is a good bit! What do you think???

Sounds great @jywarren ,
Also, @sidntrivedi012 make sure to create small modules one by one according to functionality and replace it by exporting in the file, and after testing the module move on to next function to make it easy to trace back for any errors while implementing.

[sidntrivedi012]

Ok @starkblaze01 . 👍

[jywarren]

This is looking great in the gh-pages demo! https://publiclab.github.io/spectral-workbench.js/examples/capture/

Seems like the download button isn't working, however?

[sidntrivedi012]

@jywarren Should I open an issue for it and try solving it?

[sidntrivedi012]

@jywarren Also, I need help for solving #75. I am facing an error when using the infragram code in capture's html file. I have mentioned the error here - #103 as well on the gitter channel. Please take a look. Thanks 🙂

[jywarren]

Closing this one out! Thanks all!