Source code for hiero.org — the official website for the Hiero project.
Hiero is an open-source, vendor-neutral distributed ledger technology project under Linux Foundation Decentralized Trust. It powers the Hedera public ledger and provides a fair, fast, and secure platform for decentralized applications.
This repository contains the source code, content, and documentation for the Hiero project website.
- Node.js
20or newer - pnpm
10or newer - Git
Platform-specific setup help:
pnpm install
pnpm devThe site will be available at http://localhost:3000.
| Command | Description |
|---|---|
pnpm lint |
Lint the codebase |
pnpm test |
Run unit tests |
pnpm format |
Format source files |
pnpm format:check |
Check formatting without changing files |
pnpm build |
Build the production app |
pnpm start |
Serve the production build locally |
pnpm update-snap |
Update test snapshots after intentional UI changes |
| Path | Purpose |
|---|---|
src/app |
Route files, layouts, metadata, and page entry points |
src/components |
Shared UI components (one folder per component with colocated tests) |
src/lib |
Markdown parsing and content-loading helpers |
src/data |
Generated or static JSON used by the app |
src/scripts |
Local scripts (e.g., sync-repo-stats.mjs) |
content/posts |
Blog post markdown files |
public |
Static images and assets |
docs |
Contributor and developer documentation |
For a detailed breakdown of routes, content model, and constraints, see the Repository Overview.
Detailed documentation lives in the docs/ directory. Below is a guided index organized by audience.
| Guide | Description |
|---|---|
| First Contribution Checklist | Pre-PR validation checklist |
| Contribution Workflow | End-to-end guide: fork, branch, commit, and submit a PR |
| Commit Signing Guide | Setting up DCO and GPG signing |
| Discord Guide | Joining the community chat |
| Guide | Description |
|---|---|
| Repository Overview | Architecture, directories, and route model |
| Content Folder Guide | How content is organized and loaded |
| Adding Pages | Creating new routes and markdown-backed pages |
| Components Guide | Component layout, imports, and testing conventions |
| Testing and Quality Checks | Linting, testing, and CI expectations |
| Rebasing Guide | Keeping your branch in sync with upstream |
| Merge Conflicts Guide | Resolving merge conflicts |
| Guide | Description |
|---|---|
| Blog Writing Guide | Templates, front matter reference, and publishing workflow |
| Guide | Description |
|---|---|
| GitHub Automation | CI workflows and automation overview |
We welcome contributions of all kinds — code, documentation, and blog posts.
- Find an issue: Browse unassigned open issues and comment
/assignto claim one. - Set up your environment: Follow the Getting Started section above.
- Read the workflow: See the Contribution Workflow for the full process.
- Sign your commits: All commits must be DCO and GPG signed. See the Signing Guide.
New to the project? Start with a Good First Issue.
- Discord: Join us on Discord — see the Discord Guide for details.
- Community Calls: Browse meeting schedules and recordings on the LFX Calendar.
- Discussions: Use GitHub Discussions for questions and ideas.
This project is licensed under the MIT License.