Launch HN: SideGuide (YC S22) – Learn APIs by running them in live environments
Companies use us to let developers experiment with fully-configured examples with zero setup. If you saw Hyperbeam’s interactive example on Show HN a few days ago (https://news.ycombinator.com/item?id=32598062), that was built using SideGuide.
We originally started as a B2C coding education platform after graduating college. Knowing how to use APIs has become a critical part of solving meaningful coding problems, but we watched hundreds of devs struggle to learn from API documentation. API and SDK documentation is often lacking in depth and interactive examples, leading to an incomplete understanding both of the implementation process (how to get an API or SDK working) and of the value (what you can actually do with it). We repeatedly saw students floundering with this, then wasting hours re-inventing the wheel instead of using an off-the-shelf solution.
Eventually we realized that the pain of getting an API or SDK running wasn’t just limited to students, but is something that developers have to deal with all the time—especially when deciding whether or not to use a particular product. When you just want to quickly test an API, you shouldn’t have to futz around with installations, dependencies, and whatnot. Developers and technical PMs should be able to quickly play with the real code before investing time and money in a product. That is why we built SideGuide.
SideGuide allows API/SDK companies to create instant live coding environments that help their prospective users (developers) understand the implementation process and product value through real guided examples.
A company can create a live code environment/sandbox from a GitHub repo of any product example or lab. These online code sandboxes allow developers to quickly play around and learn with no setup or friction and after they are done they export the repo for use in their own projects.
These sandboxes can have optional guides that walk potential users through different parts of the implemented code. The steps in the guides can be attached to any file or code block in the project, so nuance in the code or structure can easily be explained.
In addition, we provide observability and a feedback mechanism for the sandboxes. This is so examples and guides can constantly be improved and support can be delivered when it’s needed.
Getting this right is a challenge because it’s only valuable if you create an experience that developers love. That means spinning up environments quickly, tight integration with API documentation/authentication, and flexible workflows for all of the different types of developers.
Our solution is different from other online coding environments in two main ways. First, we are focused on APIs/SDKs. We are building features to allow developers to quickly play, test, and learn about products instead of providing a fully featured IDE like most other solutions. Second, we give API companies a white-label solution, so they do not have to send clients to another platform to play with their product. This is what Hyperbeam did with their Show HN mentioned above (https://news.ycombinator.com/item?id=32598062). As that example shows, it allows for a more seamless solution all around.
Since we want devs to be able to experiment with examples with no initial setup, we decided to build our own web-based editor with Next.js, Monaco, and Sandpack. We built the UI with Next.js, which ...
22 comments
[ 3.6 ms ] story [ 30.3 ms ] threadWould be neat if you could e.g. earn credits to use a service or points towards swag as you complete tasks for a given API.
Could see this expanding to encompass use cases like Applitools' Test Automation U https://testautomationu.applitools.com/
Gamification is always a fun addition. We want to focus on the core functionality at first, but maybe we could have some sort of leaderboard in the future (with swag attached). Cool Idea!
Never seen Applitools Test Automation U. I'm taking a look now!
I am interested in how developers can use said “observability and a feedback mechanism” in order to improve the effectiveness of their API documentation. Could you talk specifically about some of the tools you provide to developers in order improve their API documentation? What sort of metrics do you track and report?
Great job again! :)
We also track aggregate metrics, like engagement time, conversion rate, etc.
I’m co-founder of Devbook. We recently launched a live onboarding experience for Prisma https://prisma.usedevbook.com
More than happy to connect if you want!
Our Podcast API product [2] uses RunKit to provide "run node.js code right on our API docs web page". RunKit has been acquired by Stripe. It's unlikely that they'll support more languages.
It would be great to let our api users try out all api endpoints using all different languages right on our web page.
[1] https://www.runkit.com
[2] https://www.listennotes.com/api/docs/
I took a quick look at your podcast API product. First, this seems awesome! Would love to try it. Second, would love to see a web example consuming your API (if you don't have one). Maybe that's something that you could use SideGuide for and would be more aligned with our current state. Although I totally see why it would be awesome to execute all the api endpoints in different languages. Will keep that in mind and maybe explore that in the future.
I'm the co-founder of CodeSandbox and it's super cool to see Sandpack used this way in the wild! We've been working on a way to run VMs with Sandpack, maybe we could work together on it if you're interested!