Skip to content

Repository files navigation

Uklad website

The landing page for Uklad, agent-first state management for React and React Native. Deployed to uklad.js.org via GitHub Pages.

The website installs the latest package versions so its instructions stay current without requiring a website change for every package release.

There is no separate documentation site. Reference material lives in the main repository — the package READMEs and the docs/ tree — and this site links out to it.

Social previews

The static HTML provides absolute Open Graph metadata, a 1200×630 PNG social card, X Card metadata, and legacy itemprop fallbacks before the React bundle loads. That covers standard previews in LinkedIn, Facebook/Messenger, Slack, Discord, WhatsApp, Telegram, iMessage, Teams, Reddit, and Mastodon-compatible clients. After deployment, refresh any platform cache that has already scraped the homepage URL.

Project structure

uklad-website/
├── src/            # React landing page
│   ├── components/ # Shared UI (brand mark, code block, terminal)
│   └── sections/   # Page sections, top to bottom
├── public/         # Static assets, CNAME, robots.txt
└── dist/           # Build output (generated)

Scripts

Command Description
npm run dev Start the dev server
npm run build Build to dist/
npm run check Validate metadata, lint, and build
npm run preview Preview the production build
npm run lint Run ESLint

Deployment

Pushing to main triggers .github/workflows/deploy.yml, which validates, lints, builds, and publishes dist/ to GitHub Pages. The custom domain is set by public/CNAME.

Keeping content accurate

The code samples in src/sections/CodeShowcase.jsx and src/sections/QuickStart.jsx mirror the real API and the TodoMVC example. When the runtime API changes, update them together — they are the first thing visitors copy.

Tech stack

  • React 19 + Vite
  • Custom CSS, no framework
  • GitHub Pages

About

Uklad Landing Page

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages