Name: Interactive Web Component Generator
Organisation: Open Bioinformatics Foundation
Mentors: Yo Yehudi, Sarthak Sehgal
Check out the project proposal and GitHub repository of the project -
The process of updating the BioJS standard to version 3.0 is going on. The Yeoman generator to upgrade BioJS components by wrapping them in a Web Component was already created.
This project involved improving the Yeoman generator by adding new features and tests to make it easier for developers to implement old BioJS components as Web Components and to make new BioJS Web Components. It also involved clearly documenting the whole process of using the generator so as to make the task of working with the generator, making new components easy for developers as well as easily creating visualisations so that even non-technical persons can embed and use the visualisations in their work.
- Add feature to import the old component to upgrade it to a web component.
- Generate demo code for component.
- Preview images for all visualisation
- Add Tests and Linting.
- Create a tutorial.
- Added new features to the yeoman generator to easily upgrade old components to web components and make new web components. Example - Easily import old components from their npm package or only the build file.
- Added tests for all the features.
- Created a tutorial for all the features in the generator.
- The web components can be used for adding visualisations in just 9-10 lines.
- Preview images can be generated manually by taking screenshots of the visualisation and adding in the root directory of project. However there’s some work left on the BioJS website so that it uses the preview images in the root directory (if it exists) as thumbnail.
Coding Period Experience
The experience was amazing. I had a great time working on my project and I learned a lot. My mentors were so amazing and helpful, we talked daily, whenever I got stuck somewhere they helped me get out of it.
We had weekly video calls and I also wrote blogs every week summarizing my work, the tasks done, the problems I faced and the minutes of our weekly video calls. Read the blogs here.
I worked on the web components generator mostly but I also used the generator to make a new web component named BioJS Homology Tool and upgrade some old components like Complex Viewer and Protein Viewer.
My commits in the generator’s repository’s during the GSoC period can be seen here.
Check out the demos of these web components below -
The following features can be considered for the future development of this project -
Automate the process of upgrading the components. The process of upgrading existing components to web components is different from one component to another but the basic concept remains the same - get the values of the attributes from Web Component tag and use the values to generate biological visualisations. Even if the process automation is possible to a certain extent after which user needs to write the code do it.
Add feature to ask developer the inputs necessary for the component to work (generating visualisation), then add those attributes with some default values (maybe ask the developer to add these too) in the web component tag in examples/index.html. Also add these attributes, there default and valid values in templates/README and get these values in src/index.js so that user can use them in the component.
There can be some other amazing-ly helpful features too, the goal remains the same - simplifying the process of making new web components and upgrading old components to web components.