@superwall/studio 1.1.0 → 1.1.1
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 +50 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,14 +1,34 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://superwall.com/">
|
|
3
|
+
<img src="https://user-images.githubusercontent.com/3296904/158817914-144c66d0-572d-43a4-9d47-d7d0b711c6d7.png" alt="Superwall" height="100" />
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
2
6
|
|
|
3
|
-
|
|
4
|
-
|
|
7
|
+
<h1 align="center">@superwall/studio</h1>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
The studio <code>superwall dev</code> opens: every paywall and funnel as a
|
|
11
|
+
live card, and a device-frame editor with theme, locale, and variable
|
|
12
|
+
overrides.
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @superwall/studio
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
You will not usually install this directly: the
|
|
22
|
+
[`superwall`](https://www.npmjs.com/package/superwall) framework depends on
|
|
23
|
+
it and `superwall dev` serves it. It is a standalone vite + React + Tailwind
|
|
24
|
+
app that is also a component library — one codebase, two hosts:
|
|
5
25
|
|
|
6
26
|
- **`superwall dev`** serves the BUILT app (`dist/`, assets under
|
|
7
27
|
`/__studio/`) plus the data endpoint and preview mounts — the local studio.
|
|
8
28
|
- **The hosted dashboard** either embeds the built app (the way it embeds the
|
|
9
29
|
editor) or imports the components directly over platform data.
|
|
10
30
|
|
|
11
|
-
##
|
|
31
|
+
## Package layout
|
|
12
32
|
|
|
13
33
|
```
|
|
14
34
|
packages/studio/
|
|
@@ -29,10 +49,6 @@ packages/studio/
|
|
|
29
49
|
└── dist/ built by the workspace postinstall
|
|
30
50
|
```
|
|
31
51
|
|
|
32
|
-
Working on the studio: `bun dev` here (port 6200) proxies `/preview` and
|
|
33
|
-
`/__studio/project.json` to a running `superwall dev` (port 6100) in any
|
|
34
|
-
project — edit studio code with HMR against real paywalls.
|
|
35
|
-
|
|
36
52
|
## Data seam
|
|
37
53
|
|
|
38
54
|
Everything renders from a `StudioSource` — `{ title, surfaces, diagnostics?,
|
|
@@ -76,3 +92,29 @@ components, and only stateful primitives (`.sw-btn`, `.sw-chip`,
|
|
|
76
92
|
`.sw-select`, `.sw-segmented`, `.sw-switch`, `.sw-input`) as component
|
|
77
93
|
classes. Runtime dependencies are React (a peer) and `sonner` for toasts —
|
|
78
94
|
icons are inlined Lucide-geometry SVGs.
|
|
95
|
+
|
|
96
|
+
## Develop
|
|
97
|
+
|
|
98
|
+
This package lives in the [`superwall/superwall`](https://github.com/superwall/superwall)
|
|
99
|
+
monorepo. **Read [AGENTS.md](https://github.com/superwall/superwall/blob/main/AGENTS.md)
|
|
100
|
+
first** - the conventions in it are decided, not suggested.
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
bun install
|
|
104
|
+
bun dev # the studio alone on port 6200, proxied to a running
|
|
105
|
+
# `superwall dev` (port 6100) in any project — HMR against
|
|
106
|
+
# real paywalls
|
|
107
|
+
bun run build # dist/, what `superwall dev` serves
|
|
108
|
+
bun run test
|
|
109
|
+
bun run typecheck
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
The workspace `postinstall` builds `dist/`, so a fresh clone of the monorepo
|
|
113
|
+
has a studio to serve from the first `superwall dev`.
|
|
114
|
+
|
|
115
|
+
## License
|
|
116
|
+
|
|
117
|
+
[Functional Source License](https://github.com/superwall/superwall/blob/main/packages/superwall/LICENSE)
|
|
118
|
+
(FSL-1.1-ALv2): use it, modify it, embed it, ship it — anything except
|
|
119
|
+
building a competing product with it — and every release becomes Apache 2.0
|
|
120
|
+
two years after publication.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@superwall/studio",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "The Superwall studio: paywall browsing, device preview, and editing surfaces. Shared between `superwall dev` (local studio) and the hosted dashboard.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"paywall",
|