Gita Alekhya Paul - GitHub Externships Proposal #1638
gitaalekhyapaul
started this conversation in
Externship
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
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