Quick Start Guide
Get up and running with the Hack Club Platform™ in three easy steps:
- Open a browser. Any browser. We recommend Chrome but honestly we'll take what we can get.
- Go to our website. You're already here. Congratulations.
- You're done. There is no platform. This is a static HTML page hosted on GitHub Pages for free. You have completed onboarding. Welcome aboard.
Estimated setup time: 0 minutes. Average time users spend confused anyway: 14 minutes.
API Documentation
We don't have an API. We know this page is called "Documentation" and there is a section labeled "API Documentation," and we understand that creates certain expectations. We're sorry.
For our complete API reference (which documents an API that does not exist), please visit the API Reference page. It has endpoints and everything. None of them work.
SDK & Libraries
We made a JavaScript file once. It was 14 lines long. It validated an email address (poorly). We were very proud of it.
We lost it. It was not in version control because we hadn't learned about Git yet. This was before Brian quit. Brian said he had a backup. Brian lied.
If you find a file called hackclub-sdk-v0.0.1-beta-FINAL.js on a USB drive somewhere in the computer lab, please return it. It is our entire engineering output from 2022.
Deployment Guide
Our deployment process is industry-leading in its simplicity:
- Push to main.
- Pray.
There are no other steps. We do not have staging. We do not have CI/CD. We do not have rollbacks. If something breaks, we push again and hope the second commit fixes whatever the first commit broke. This has a 30% success rate, which we consider acceptable.
Was this documentation helpful?
This feedback form does not work. The buttons are not connected to anything. We appreciate the thought, though.