You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
About me: I am an MLH (Batch 2) Fellow, currently contributing to the AWS Amplify CLI project. I am primarily a Node.js backend developer, love writing code in TypeScript, and fuelled by coffee.
Proposal description: The proposal aims to work on some feature requests mentioned in issue hoppscotch/hopp-doc-gen#8, as well as work on a gradual migration from JavaScript to TypeScript.
As the codebase of the CLi increases day-to-day, with more and more features being added to it, type safety is of utmost importance. TypeScript ensures strict type definitions of functions and classes. Along with the codebase, the tests are also to be written in TS.
Apart from the migration, certain bug fixes, and feature improvements, this proposal aims to work. The first being the CORS issue while using the GET buttons on the website. That has to be due to the misconfiguration in the Vuepress template. Apart from that, currently, the buttons are supported for GET requests only. The proposal aims to integrate buttons for all types of HTTP requests, giving the user the option to set a proper documentation website for their API through the CLI. The proposal can take inspiration for the front-end from Swagger UI.
Another aspect the proposal aims to solve is creating an efficient way of deploying the website through the CLI. The inspiration for this feature has been taken from Docusaurus proposal aims to set up deployment workflows for the CLI so that the developer can generate and push their code to deployment straight from the CLI.
Proposal roadmap: (brief list of things you will do/create, in some rough chronological order)
Reading up on the codebase, understanding each and every feature flag and arguments
Clearing all doubts regarding the codebase, proceeding to read up on the testing architecture
1st week of migrating CLI code from JS to TS
2nd Week of migrating CLI code from JS to TS
1st Week of implementing deployment workflows to the CLI
2nd Week of implementing deployment workflows to the CLI
Migrating Tests from JS to TS
Bug Fixing and Pending Work Buffer
1st Week of Integrating Buttons and forms for the remaining HTTP requests
2nd Week of Integrating Buttons and forms for the remaining HTTP requests
3rd Week of Integrating Buttons and forms for the remaining HTTP requests
Finishing up documenting the changes made for easier onboarding of future contributors and fixing bugs.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Application number: 26-04_Git375_tfa_262
Full name: Gita Alekhya Paul
About me: I am an MLH (Batch 2) Fellow, currently contributing to the AWS Amplify CLI project. I am primarily a Node.js backend developer, love writing code in TypeScript, and fuelled by coffee.
E-mail:
GitHub username: @gitaalekhyapaul
Prior experience:
Proposal type:
Proposal title: Changes to
hopp-doc-gen
Proposal description: The proposal aims to work on some feature requests mentioned in issue hoppscotch/hopp-doc-gen#8, as well as work on a gradual migration from JavaScript to TypeScript.
As the codebase of the CLi increases day-to-day, with more and more features being added to it, type safety is of utmost importance. TypeScript ensures strict type definitions of functions and classes. Along with the codebase, the tests are also to be written in TS.
Apart from the migration, certain bug fixes, and feature improvements, this proposal aims to work. The first being the CORS issue while using the
GET
buttons on the website. That has to be due to the misconfiguration in the Vuepress template. Apart from that, currently, the buttons are supported forGET
requests only. The proposal aims to integrate buttons for all types of HTTP requests, giving the user the option to set a proper documentation website for their API through the CLI. The proposal can take inspiration for the front-end from Swagger UI.Another aspect the proposal aims to solve is creating an efficient way of deploying the website through the CLI. The inspiration for this feature has been taken from Docusaurus proposal aims to set up deployment workflows for the CLI so that the developer can generate and push their code to deployment straight from the CLI.
Proposal roadmap: (brief list of things you will do/create, in some rough chronological order)
Beta Was this translation helpful? Give feedback.
All reactions