Skip to content

Repository files navigation

Selendra website and docs

The site behind selendra.org: marketing pages, the whitepaper, the blog, and the developer documentation.

Running it

Bun only. No npm, yarn or pnpm.

bun install
bun dev          # http://localhost:3000
bun run build
bun start

Tests use Vitest.

bun test              # watch mode
bun run test:coverage

Layout

app/            routes and the single stylesheet (app/globals.css)
components/     shared React components, ui/ holds the shadcn primitives
content/docs/   67 documentation pages, markdown with frontmatter
content/blog/   blog posts
content/paper/  whitepaper.md
lib/            content loaders, network API, search index
hooks/          client hooks
tests/          Vitest specs for lib and components

Routes: /, /about, /about/branding, /blog, /docs, /ecosystem, /license, /network, /playground, /privacy, /status, /technology, /terms, /tools, /tools/address-converter, /use-cases, /whitepaper.

Adding content

Docs live in content/docs/<section>/<page>.md. Frontmatter:

---
title: "Page title"
description: "One line for search results and the sidebar"
section: "Section name"
order: 3
---

New pages also need an entry in lib/docs-sidebar-config.ts, which owns sidebar order and grouping.

Blog posts go in content/blog/ with title, excerpt, date, author, category and readTime. The whitepaper is a single file, content/paper/whitepaper.md.

Every factual claim about the chain (block time, chain IDs, validator counts, finality) has to trace back to the node repository or a live endpoint. Do not round numbers up, and do not restate a figure the chain cannot confirm.

Environment

Both variables have working defaults in lib/network-api.ts, so local development needs no .env. Copy .env.local.example to .env.local to point the site at a different network.

Variable Default Purpose
NEXT_PUBLIC_CHAIN_ENV mainnet Selects chain ID 1961 (mainnet) or 1953 (testnet)
NEXT_PUBLIC_EXPLORER_API https://explorer.selendra.org/api/v2/stats Blockscout stats endpoint for live network numbers

Deploying

The build emits Next.js standalone output, so any Node 20 host can serve it. DOCKER.md covers the container path.

Stack

Next.js 16 (App Router), React 19, TypeScript, Tailwind CSS 4, Radix primitives, remark and rehype for markdown, highlight.js for code, Mermaid for diagrams.

Fonts are Inter and JetBrains Mono, loaded through next/font.

Contributing

See CONTRIBUTING.md.

Licence

Code and content in this repository: MIT, see LICENSE. The Selendra node software is Apache-2.0 and lives in selendra/selendra. The name, logo and branding are not covered by either.

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages