https://github.com/3kh0/hcbscan
The first public explorer for HCB transactions and organizations.
https://github.com/3kh0/hcbscan
explorer hackclub hcb
Last synced: 3 months ago
JSON representation
The first public explorer for HCB transactions and organizations.
- Host: GitHub
- URL: https://github.com/3kh0/hcbscan
- Owner: 3kh0
- License: gpl-3.0
- Created: 2025-01-26T07:42:48.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-06-12T22:05:44.000Z (4 months ago)
- Last Synced: 2025-07-21T16:11:39.496Z (3 months ago)
- Topics: explorer, hackclub, hcb
- Language: Vue
- Homepage: https://hcbscan.3kh0.net
- Size: 1.54 MB
- Stars: 26
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
HCBScan
The first public explorer for HCB transactions and organizations.
About •
Features •
Project Structure •
Local Setup •
Configuration •
Deployment •
License
## About
HCBScan is an open-source explorer for [HCB](https://hcb.hackclub.com/) that allows you to search for organizations, view transactions, and explore public financial data. It is built using [Nuxt](https://nuxt.com) and [Vue](https://vuejs.org) with a little help from [Supabase](https://supabase.com/) and it uses the [HCB API](https://hcb.hackclub.com/docs/api/v3) to fetch data.
### Live Demo
Try out HCBScan at [hcbscan.3kh0.net](https://hcbscan.3kh0.net/)
## Features
- Search for organizations by name, handle, or ID
- View all information about organizations, including the stuff that is not shown normally!
- Explore recent activities and transactions across the platform
- See how much money is held within HCB
- Support for third-party instances
## Structure
```filestructure
hcbscan/
├── assets/ # see title
│ ├── css/ # tailwind + overrides
│ └── img/ # images
├── components/ # reusable components
├── layouts/
│ └── default.vue # default layout
├── pages/ # the meat and bones
│ ├── app/ # all cool stuff here
│ │ ├── index.vue # the real homepage
│ │ ├── acts/ # activity page
│ │ ├── txns/ # transaction page
│ │ └── org/ # organization page
│ └── index.vue
├── public/ # stuff, ignore
├── server/ # not sure why this is here honestly
├── utils/ # utility functions
├── app.vue # nothing much here
└── nuxt.config.ts # nuxt configuration
```
## Local Setup
### Prerequisites
- Node.js
- pnpm
- A browser made within the past decade
### Installation
1. Clone the repository:
```bash
git clone https://github.com/3kh0/hcbscan.git
cd hcbscan
pnpm install
pnpm dev
```
2. Open your browser and go to `http://localhost:3000`
## Configuration
### Supabase
HCBScan uses Supabase for some added functions. If you want to bring your own database and not use the default one, you can edit the [`utils/supabase.js`](utils/supabase.js) file with your own Supabase URL and public key.
### Third Party instances
HCB is open source and HCBScan supports third-party instances. If you want to use a different instance, you can edit the [`utils/apiConfig.js`](utils/apiConfig.js) to change the default HCB API URL to your desired instance.
By default, it uses the official HCB API.
## Deployment
HCBScan is built on Nuxt, which means it runs pretty much everywhere. Cloudflare Pages is recommended as it is the easiest to setup and use, all while being free.
## Contributing
Contributions are welcome and I will love you forever if you help out! There is a informal todo list over at [`todo.txt`](todo.txt) if you want to help out.
## License
This project is licensed under the GNU GPLv3 License - see the [`LICENSE.txt`](LICENSE.txt) file for details.
## Thanks
- Made with 💚 by [Echo](https://3kh0.net)
- Powered by [Nuxt](https://nuxt.com) and [Vue](https://vuejs.org)
- Data provided by the [HCB API](https://hcb.hackclub.com/docs/api/v3)
- Let's be honest, stack overflow
**Note**: HCBScan is not affiliated, fiscally sponsored, or endorsed by HCB. We only got a "oh shit, this is so cool" from the HCB team so take that for what it is worth.