About • Features • Project Structure • Local Setup • Configuration • Deployment • License
HCBScan is an open-source explorer for HCB that allows you to search for organizations, view transactions, and explore public financial data. It is built using Nuxt and Vue with a little help from Supabase and it uses the HCB API to fetch data.
Try out HCBScan at hcbscan.3kh0.net
- 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
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
- Node.js
- pnpm
- A browser made within the past decade
- Clone the repository:
git clone https://github.com/3kh0/hcbscan.git
cd hcbscan
pnpm install
pnpm dev- Open your browser and go to
http://localhost:3000
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 file with your own Supabase URL and public key.
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 to change the default HCB API URL to your desired instance.
By default, it uses the official HCB API.
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.
Contributions are welcome and I will love you forever if you help out! There is a informal todo list over at todo.txt if you want to help out.
This project is licensed under the GNU GPLv3 License - see the LICENSE.txt file for details.
- Made with 💚 by Echo
- Powered by Nuxt and Vue
- Data provided by the HCB API
- 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.