Deepanshu Dhruw - Github Externship Proposal

[devblin]

Full name: Deepanshu Dhruw

About me: I am currently a junior at National Institute of Technology, Trichy, pursuing B.Tech in Instrumentation and Control.
I am passionate about programming and open-source. I have contributed to few open-source projects such as notifire, tooljet, focused-browsing and snipp.in. I also recently contributed to hoppscotch's projects hoppscotch and hopp-cli.

E-mail:

• Personal: dhruwxl@gmail.com
• College: 110119035@nitt.edu

GitHub username: @devblin

Prior experience:

• HTML
• CSS
• SCSS
• Tailwind CSS
• JavaScript
• TypeScript
• Vue.js
• Nuxt.js
• NestJS
• Firebase
• Prisma
• GraphQL
• PostgreSQL
• Go lang

---

Proposal type:

• Existing feature request
• New feature proposal
• Refactor existing feature

Proposal title: hopp-cli support for cloud.

Proposal description:
Aim of this proposal is to add major cloud features supported in hoppscotch.io web-app into hopp-cli. Most of the features will use existing hoppscotch APIs.

Following are the list of major feature:

• User authentication: Login through cli to access teams, collections.
  • User will recieve unique login code which will be used during authentication.
  • Authentication token will be saved within config file.
  • User's can also logout, along with this user will be given option whether to delete local requests data from their system or not.
• View, import, export collections: Logged-in user can access collections.
  • Listing individual and teams collection.
  • Uploading collection from json file(s) to respective collection category.
  • Downloading collection using unique collection-id.
• Requests logs: Details of requests stored locally (using key-value database such as bolt) in user's system with each request data assigned an unique key.
  • Viewing request logs with basic data in format:
    request-id : method, url.
  • Viewing details of a request using request-id.
  • Syncing locally stored requests history to cloud.
• Teams operations: Accessing teams data of user.
  • Creating team(s).
  • Viewing team(s) with basic data in format:
    team-id: team-name, owner
  • Viewing details of a team using team-id.

Some minor update(s):

• Loaders: Some tasks such as sending request, waiting for response etc, can be slow based on network, so for such operations animated loaders can be helpful to provide user visual feedback of process going on.

Proposal roadmap:

1. Understanding codebase and discussing authentication flow details.
2. User authentication flow implementation and testing.
3. Collection listing, downloading and uploading commands implementation and testing.
4. Discussing and testing suitable key-value database for storing request logs.
5. Request logs commands implementation and testing.
6. Teams operations commands implementation and testing.
7. Adding loaders to new & existing cli operations.
8. Documenting newly addded features and performing complete testing.