README.md at main · desertthunder.dev/voltx

desertthunder.dev / voltx
a reactive (signals based) hypermedia web framework (wip) stormlightlabs.github.io/volt/
hypermedia frontend signals
voltx / README.md
at main 2.6 kB view raw view rendered
 1# VoltX.js
 2
 3[![codecov](https://codecov.io/gh/stormlightlabs/volt/branch/main/graph/badge.svg)](https://codecov.io/gh/stormlightlabs/volt)
 4[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 5[![JSR](https://jsr.io/badges/@voltx/core)](https://jsr.io/@voltx/core)
 6![NPM Version](https://img.shields.io/npm/v/voltx.js?logo=npm)
 7![Status - Test](https://github.com/stormlightlabs/volt/actions/workflows/test.yml/badge.svg)
 8![Status - Lint](https://github.com/stormlightlabs/volt/actions/workflows/lint.yml/badge.svg)
 9
10> ⚠️ **Pre-release Software**: VoltX.js remains in active development. Expect breaking changes until v1.0 and evaluate before using in production.
11
12Volt is a monorepo centered around the VoltX.js runtime—a lightweight, declarative alternative to component-centric UI frameworks. The repo also ships the Volt CLI and the documentation site that demonstrates and explains the runtime.
13
14## Local Development
15
16### Packages
17
18```sh
19volt/
20├── lib/   VoltX.js runtime published to npm (`voltx.js`) and JSR (`@voltx/core`)
21├── dev/   VoltX dev CLI and local tooling
22├── cli/   Project scaffolding and management CLI (`create-voltx`)
23└── docs/  VitePress documentation site
24```
25
26### Getting Started
27
28- Runtime usage: see [`lib/README.md`](./lib/README.md) for installation guides and quick-start examples.
29- Local development: `pnpm install` then `pnpm --filter lib dev` run package-specific scripts (`build`, `test`, etc.).
30    - Review [contribution](./CONTRIBUTING.md) guidelines
31- Documentation: `pnpm docs:dev` launches the VitePress site.
32
33### Working on New Features
34
35The `lib/` package includes a comprehensive demo Vite app showcasing all VoltX.js features:
36
37```sh
38# Start the demo development server
39pnpm --filter voltx.js dev
40```
41
42The demo app essentially provides an interactive sandbox to develop and catch bugs in new implementations.
43
44#### Pages
45
46- **Home**: Framework overview and quick start examples
47- **CSS**: VoltX.css typography, layout, and component features
48- **Interactivity**: Dialogs, buttons, event handling
49- **Forms**: Two-way binding and form validation patterns
50- **Reactivity**: Signals, computed values, conditional/list rendering
51- **Plugins**: Persistence, scroll management, URL sync
52- **Animations**: Transitions and keyframe animations
53
54Docs are the source of truth but take advantage of this environment. When developing new features, add examples to the appropriate demo section or create a new page to showcase the functionality.
55
56## License
57
58[MIT License](./lib/LICENSE) © 2025 Stormlight Labs