@funstack/static 0.0.2-alpha.0 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# @funstack/static
|
|
2
|
+
|
|
3
|
+
A maximally minimal React framework. Vite plugin for static sites with RSC support.
|
|
4
|
+
|
|
5
|
+
> [!WARNING]
|
|
6
|
+
> This is work in progress.
|
|
7
|
+
|
|
8
|
+
## Features
|
|
9
|
+
|
|
10
|
+
- :x: **No server runs** - perfect for CSR (Client Side Rendering) app and static deployment.
|
|
11
|
+
- :x: **No RCE vulnerabilities** - No server, no risk.
|
|
12
|
+
- :white_check_mark: **RSC support** - React Server Components are supported even without a server which helps reduce bundle size and improve performance.
|
|
13
|
+
- :white_check_mark: **Server Component Code Splitting** - a brand new `defer()` API allows you to split RSC Payload into multiple chunks and load them on demand.
|
|
14
|
+
- :white_check_mark: **Vite-based** - so minimal that this framework is served as a Vite plugin (based on [@vitejs/plugin-rsc](https://github.com/vitejs/vite-plugin-react/tree/main/packages/plugin-rsc#readme))
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
```sh
|
|
19
|
+
npm install @funstack/static
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Quick Start
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
// vite.config.ts
|
|
26
|
+
import funstackStatic from "@funstack/static";
|
|
27
|
+
import react from "@vitejs/plugin-react";
|
|
28
|
+
import { defineConfig } from "vite";
|
|
29
|
+
|
|
30
|
+
export default defineConfig({
|
|
31
|
+
plugins: [
|
|
32
|
+
funstackStatic({
|
|
33
|
+
root: "./src/root.tsx",
|
|
34
|
+
app: "./src/App.tsx",
|
|
35
|
+
}),
|
|
36
|
+
react(),
|
|
37
|
+
],
|
|
38
|
+
});
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Documentation
|
|
42
|
+
|
|
43
|
+
For detailed API documentation and guides, visit the **[Documentation](https://uhyo.github.io/funstack-static/)**.
|
|
44
|
+
|
|
45
|
+
## License
|
|
46
|
+
|
|
47
|
+
MIT
|