Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

Commit a80cfc8

Browse files
vitbokischvitbokisch
authored
Merge pull request #20 from pyreon/update-all-docs
Update all READMEs with current features
2 parents c4e0c1a + 9170b2e commit a80cfc8

5 files changed

Lines changed: 176 additions & 57 deletions

File tree

‎README.md‎

Lines changed: 52 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,72 @@
11
# Pyreon Zero
22

3-
Zero-config full-stack framework powered by [Pyreon](https://github.com/user/pyreon) and [Vite](https://vite.dev).
4-
5-
## Packages
6-
7-
| Package | Description |
8-
| --- | --- |
9-
| [`@pyreon/zero`](packages/zero/) | Core framework — routing, SSR, components, plugins |
10-
| [`zero-cli`](packages/cli/) | CLI for dev, build, and preview |
11-
| [`create-zero`](packages/create-zero/) | Project scaffolding tool |
3+
Full-stack meta-framework powered by [Pyreon](https://github.com/pyreon/pyreon)'s signal-based reactivity and [Vite](https://vite.dev).
124

135
## Quick Start
146

157
```bash
16-
bun create zero my-app
8+
bun create @pyreon/zero my-app
179
cd my-app
10+
bun install
1811
bun run dev
1912
```
2013

14+
The interactive CLI lets you pick your rendering mode, features, and AI toolchain.
15+
16+
## Packages
17+
18+
| Package | Description |
19+
| --- | --- |
20+
| [`@pyreon/zero`](packages/zero/) | Framework — routing, SSR, components, middleware, plugins |
21+
| [`@pyreon/meta`](packages/meta/) | Ecosystem barrel — re-exports fundamentals + UI system |
22+
| [`@pyreon/zero-cli`](packages/cli/) | CLI — dev, build, preview, doctor, context, create |
23+
| [`@pyreon/create-zero`](packages/create-zero/) | Interactive project scaffolding |
24+
2125
## Features
2226

23-
- File-based routing with layouts, error boundaries, and loading states
24-
- SSR, SSG, ISR, and SPA rendering modes
25-
- Streaming server-side rendering
26-
- Optimized `<Image>`, `<Link>`, and `<Script>` components
27-
- Google Fonts with build-time self-hosting
28-
- Dark/light theme system with no flash
29-
- SEO utilities — sitemap, robots.txt, JSON-LD
30-
- Cache and security middleware
31-
- Node.js, Bun, and static adapters
27+
**Routing & Rendering**
28+
- File-based routing with layouts, error boundaries, loading states, route groups
29+
- SSR (streaming + string), SSG, ISR, SPA rendering modes (per-route configurable)
30+
- API routes — `.ts` files in `src/routes/api/` with HTTP method handlers
31+
- Per-route middleware and navigation guards
32+
33+
**Components**
34+
- `<Image>` — lazy load, srcset, blur-up, priority, CLS prevention
35+
- `<Link>` — prefetch (hover/viewport), active state, 3-level API
36+
- `<Script>` — loading strategies (beforeHydration, afterHydration, onIdle, onInteraction, onViewport)
37+
38+
**Server**
39+
- Server actions — `defineAction()` for mutations with client/server boundary
40+
- CORS, rate limiting, compression, cache, security middleware
41+
- Node.js, Bun, and static deploy adapters
42+
43+
**Ecosystem (via @pyreon/meta)**
44+
- State: `@pyreon/store` — signal-based stores
45+
- Data: `@pyreon/query` — TanStack Query adapter
46+
- Forms: `@pyreon/form` + `@pyreon/validation` — Zod/Valibot/ArkType
47+
- CRUD: `@pyreon/feature` — schema-driven features
48+
- Tables: `@pyreon/table`, Virtual lists: `@pyreon/virtual`
49+
- i18n: `@pyreon/i18n` — translations, plurals, rich text
50+
- Styling: `@pyreon/styler` — CSS-in-JS
51+
- UI: `@pyreon/elements`, `@pyreon/coolgrid`, `@pyreon/hooks`
52+
- Animations: `@pyreon/kinetic` + 120 presets
53+
54+
**DX**
55+
- Theme system with anti-flash, Google Fonts self-hosting, SEO utilities
56+
- Dev error overlay with source-mapped stack traces
57+
- Route table printed on `zero dev` startup
58+
- AI toolchain — MCP server, CLAUDE.md, `zero doctor`
59+
- Testing utilities — `createTestContext`, `testMiddleware`, `createTestApiServer`
3260

3361
## Development
3462

3563
```bash
3664
bun install
37-
bun run dev # Dev mode
38-
bun run build # Build all packages
39-
bun run test # Run tests
40-
bun run typecheck # Type check all packages
65+
bun run dev # Dev mode
66+
bun run build # Build all packages
67+
bun run test # Run tests (309 tests)
68+
bun run typecheck # Type check all packages
69+
bun run test:template # Validate starter template
4170
```
4271

4372
## License

‎packages/cli/README.md‎

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,51 @@
1-
# zero-cli
1+
# @pyreon/zero-cli
22

3-
CLI for [Pyreon Zero](https://github.com/user/pyreon-zero) — dev server, production builds, and preview.
3+
Unified CLI for [Pyreon Zero](https://github.com/pyreon/zero) — development, builds, code quality, and project scaffolding.
44

55
## Install
66

77
```bash
8-
bun add -D zero-cli
8+
bun add -D @pyreon/zero-cli
99
```
1010

1111
## Commands
1212

13+
### Development
14+
15+
```bash
16+
zero dev [root] # Start dev server (prints route table on startup)
17+
--port <port> # Server port (default: 3000)
18+
--host [host] # Server host (use --host for 0.0.0.0)
19+
--open # Open browser on start
20+
21+
zero build [root] # Build for production
22+
--mode <mode> # Rendering mode override (ssr, ssg, spa)
23+
24+
zero preview [root] # Preview production build
25+
--port <port> # Server port (default: 3000)
26+
--host [host] # Server host
27+
```
28+
29+
### Code Quality
30+
1331
```bash
14-
zero dev [root] # Start development server
15-
zero build [root] # Build for production
16-
zero preview [root] # Preview production build
32+
zero doctor [root] # Detect React patterns in codebase
33+
--fix # Auto-fix fixable issues (className → class, etc.)
34+
--json # Output as JSON
35+
--ci # CI mode — exit with code 1 on errors
1736
```
1837

19-
### Options
38+
### Project Context
2039

2140
```bash
22-
# dev / preview
23-
--port <port> # Server port (default: 3000)
24-
--host [host] # Server host
25-
--open # Open browser on start
41+
zero context [root] # Generate AI project context (.pyreon/context.json)
42+
--out <path> # Custom output path
43+
```
2644

27-
# build
28-
--mode <mode> # Rendering mode override (ssr, ssg, spa)
45+
### Scaffolding
46+
47+
```bash
48+
zero create <name> # Scaffold a new Pyreon Zero project
2949
```
3050

3151
## License

‎packages/create-zero/README.md‎

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,40 @@
1-
# create-zero
1+
# @pyreon/create-zero
22

3-
Scaffold a new [Pyreon Zero](https://github.com/user/pyreon-zero) project.
3+
Interactive scaffolding tool for [Pyreon Zero](https://github.com/pyreon/zero) projects.
44

55
## Usage
66

77
```bash
8-
bun create zero my-app
8+
bun create @pyreon/zero my-app
99
```
1010

11-
Or with npx:
11+
Or via the CLI:
1212

1313
```bash
14-
npx create-zero my-app
14+
zero create my-app
1515
```
1616

17-
## What's Included
17+
## Interactive Setup
1818

19-
The default template sets up a full-featured project with:
19+
The CLI prompts you to configure:
2020

21-
- Streaming SSR
22-
- Dark/light theme
23-
- Font optimization
24-
- SEO (sitemap, robots.txt)
25-
- Cache and security middleware
26-
- File-based routing with example routes
27-
- Error and loading boundaries
28-
- Route guards
21+
1. **Rendering mode** — SSR Streaming, SSR String, SSG, or SPA
22+
2. **Features** — pick from store, query, forms, feature CRUD, i18n, tables, virtual lists, CSS-in-JS, UI elements, animations, hooks
23+
3. **AI toolchain** — MCP server config, CLAUDE.md, doctor scripts
24+
25+
## What Gets Generated
26+
27+
Based on your selections:
28+
29+
- `package.json` — only the dependencies you chose
30+
- `vite.config.ts` — configured for your rendering mode
31+
- `src/entry-server.ts` — matching SSR/stream config with CORS + rate limiting
32+
- `src/routes/` — example pages, API routes, protected dashboard
33+
- `src/features/` — feature example with Zod schema (if selected)
34+
- `src/stores/` — store example (if selected)
35+
- `.mcp.json` — AI IDE integration (if AI toolchain selected)
36+
- `CLAUDE.md` — project rules for AI agents (if AI toolchain selected)
37+
- `env.d.ts` — virtual module type declarations
2938

3039
## License
3140

‎packages/meta/README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# @pyreon/meta
2+
3+
Barrel package re-exporting the full Pyreon ecosystem — fundamentals and UI system.
4+
5+
Import everything from one place instead of installing each package individually.
6+
7+
## Install
8+
9+
```bash
10+
bun add @pyreon/meta
11+
```
12+
13+
## What's Included
14+
15+
### Fundamentals
16+
17+
| Package | Key Exports |
18+
| --- | --- |
19+
| `@pyreon/store` | `defineStore`, `signal`, `computed`, `effect`, `batch` |
20+
| `@pyreon/form` | `useForm`, `useField`, `useFieldArray`, `FormProvider` |
21+
| `@pyreon/validation` | `zodSchema`, `zodField` |
22+
| `@pyreon/query` | `useQuery`, `useMutation`, `QueryClient`, `QueryClientProvider` |
23+
| `@pyreon/table` | `useTable`, `flexRender` |
24+
| `@pyreon/virtual` | `useVirtualizer`, `useWindowVirtualizer` |
25+
| `@pyreon/i18n` | `createI18n`, `I18nProvider`, `useI18n`, `Trans` |
26+
| `@pyreon/feature` | `defineFeature`, `reference` |
27+
28+
### UI System
29+
30+
| Package | Key Exports |
31+
| --- | --- |
32+
| `@pyreon/styler` | `css`, `styled`, `createGlobalStyle`, `keyframes` |
33+
| `@pyreon/hooks` | 25+ signal-based hooks (`useHover`, `useFocus`, `useBreakpoint`, etc.) |
34+
| `@pyreon/elements` | `Element`, `Text`, `List`, `Overlay`, `Portal`, `Iterator` |
35+
| `@pyreon/unistyle` | `makeItResponsive`, `normalizeTheme`, `sortBreakpoints` |
36+
| `@pyreon/coolgrid` | `Col`, `Container`, `Row` |
37+
| `@pyreon/kinetic` | `kinetic`, `useAnimationEnd`, `useTransitionState` |
38+
| `@pyreon/kinetic-presets` | `createFade`, `createSlide`, `createScale`, `createRotate`, `createBlur` |
39+
| `@pyreon/attrs` | `attrs` |
40+
| `@pyreon/rocketstyle` | `rocketstyle` |
41+
42+
## Usage
43+
44+
```ts
45+
import { defineStore, signal, useQuery, useForm, styled, useHover } from "@pyreon/meta"
46+
```
47+
48+
## License
49+
50+
[MIT](LICENSE)

‎packages/zero/README.md‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @pyreon/zero
22

3-
Core meta-framework for building full-stack apps with [Pyreon](https://github.com/user/pyreon) and [Vite](https://vite.dev).
3+
Core meta-framework for building full-stack apps with [Pyreon](https://github.com/pyreon/pyreon) and [Vite](https://vite.dev).
44

55
## Install
66

@@ -11,14 +11,19 @@ bun add @pyreon/zero
1111
## Features
1212

1313
- **File-based routing** — `[param]`, `[...catchAll]`, `_layout`, `_error`, `_loading`, `(groups)`
14-
- **Rendering modes** — SSR, SSG, ISR, SPA (per-route configurable)
14+
- **Rendering modes** — SSR (streaming + string), SSG, ISR, SPA (per-route configurable via `renderMode` export)
15+
- **API routes** — `.ts` files in `src/routes/api/` export HTTP method handlers (`GET`, `POST`, `PUT`, `DELETE`)
16+
- **Server actions** — `defineAction()` for mutations with automatic client/server boundary detection
17+
- **Per-route middleware** — route files export `middleware` using `@pyreon/server`'s signature
1518
- **Components** — `<Image>` (lazy load, srcset, blur-up), `<Link>` (prefetch, active state), `<Script>` (loading strategies)
1619
- **Theme** — Dark/light/system with `theme` signal, `<ThemeToggle>`, and anti-flash inline script
1720
- **Fonts** — Google Fonts self-hosting at build time, local fonts, size-adjusted fallbacks
1821
- **Image optimization** — Build-time processing via `?optimize` imports (WebP/AVIF, blur placeholders)
1922
- **SEO** — Sitemap, robots.txt, JSON-LD helpers (Vite plugin + dev middleware)
20-
- **Cache & security** — `cacheMiddleware()`, `securityHeaders()`, `varyEncoding()`
23+
- **Middleware** — `cacheMiddleware()`, `securityHeaders()`, `corsMiddleware()`, `rateLimitMiddleware()`, `compressionMiddleware()`
2124
- **Adapters** — Node.js, Bun, static
25+
- **Testing** — `createTestContext()`, `testMiddleware()`, `createTestApiServer()`, `createMockHandler()`
26+
- **Dev overlay** — Styled error overlay with source-mapped stack traces for SSR errors
2227

2328
## Usage
2429

@@ -28,16 +33,17 @@ import pyreon from "@pyreon/vite-plugin"
2833
import zero from "@pyreon/zero"
2934

3035
export default {
31-
plugins: [pyreon(), zero({ mode: "ssr" })],
36+
plugins: [pyreon(), zero({ mode: "ssr", ssr: { mode: "stream" } })],
3237
}
3338
```
3439

3540
## Subpath Exports
3641

3742
| Export | Description |
3843
| --- | --- |
39-
| `@pyreon/zero` | Vite plugin, config, adapters |
44+
| `@pyreon/zero` | Vite plugin, config, adapters, components, middleware |
4045
| `@pyreon/zero/client` | Client-side entry (`startClient`) |
46+
| `@pyreon/zero/config` | `defineConfig`, `resolveConfig` |
4147
| `@pyreon/zero/image` | `<Image>` component |
4248
| `@pyreon/zero/link` | `<Link>`, `useLink`, `createLink` |
4349
| `@pyreon/zero/script` | `<Script>` component |
@@ -46,7 +52,12 @@ export default {
4652
| `@pyreon/zero/cache` | Cache and security middleware |
4753
| `@pyreon/zero/seo` | SEO plugin, sitemap, robots.txt |
4854
| `@pyreon/zero/image-plugin` | Image optimization Vite plugin |
49-
| `@pyreon/zero/config` | Config types |
55+
| `@pyreon/zero/actions` | `defineAction`, `createActionMiddleware` |
56+
| `@pyreon/zero/api-routes` | API route utilities and middleware |
57+
| `@pyreon/zero/cors` | CORS middleware |
58+
| `@pyreon/zero/rate-limit` | Rate limiting middleware |
59+
| `@pyreon/zero/compression` | Compression middleware |
60+
| `@pyreon/zero/testing` | Test utilities for middleware and API routes |
5061

5162
## License
5263

0 commit comments

Comments
 (0)