Inspiration

From a meme we saw at twitter made me think, "why there is no voice/multimedia commenting in programming?" We all stuck with simple text based dev-to-dev communications. And devs are so bad at documenting stuff they build.

What it does

It give a better way to communicate with your team with simple images & voice comment. All you need is to hover on the //comment and enjoy the song of depressed dev who build this. It is also available in both browser & vscode extensions. Improves the overall PR & Developer eXperience. Also it can bundle & auto-generate organization documentation process.

How we built it

ofcourse typescript & vite. also some electron depended libraries.

Challenges we ran into

Browser doesn't support injecting multimedia as extension. Vscode doesn't support direct microphone hardware access. Found some solutions, but time made us limited what we got.

Accomplishments that we're proud of

Image & Video hover in vscode. Inbuild //comment to MD bundling (for auto-organization document generation) Browser plugin with github login & api (helped us inject raw data in dom)

What we learned

Lot of electron problems + browser restrictions. Build a state hook for vscode. Lot of regex and and DOM injections. VScode & Broswer apis

What's next for 25_Nexus_Comment-it

We gonna build a direct voice plugin for vscode, so people can use it. Using proxy to overcome github api regulations. Support for both v2 & v3 manifest (browser ext). Self-host for organizations to reduce repo storage size & api ratelimiting. Free plan for FOSS & personal projects. Docasoras + Ci/CD pipline for faster doc builds.

Built With

Share this project:

Updates