create-shopnex 0.0.0-edge.ec83953 → 0.0.0-edge.init
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 +3 -29
- package/dist/main.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,38 +3,12 @@
|
|
|
3
3
|
Try ShopNex on your machine with one command. It starts the admin (with the API and hosted checkout) and the
|
|
4
4
|
storefront on an embedded database ([PGlite](https://pglite.dev)): no PostgreSQL, no Docker, no clone.
|
|
5
5
|
|
|
6
|
-
## Run it
|
|
7
|
-
|
|
8
6
|
```sh
|
|
9
|
-
npx create-shopnex
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
npm asks once whether to install the package: answer `y`. `@latest` makes npx fetch the newest version instead of
|
|
13
|
-
reusing an older copy from its cache. With pnpm, which does not ask:
|
|
14
|
-
|
|
15
|
-
```sh
|
|
16
|
-
pnpm create shopnex@latest
|
|
7
|
+
npx create-shopnex
|
|
17
8
|
```
|
|
18
9
|
|
|
19
10
|
The first run downloads ShopNex (one file, about 15 MB) into `~/.shopnex/app/<version>` and checks its SHA-256; later
|
|
20
|
-
runs start straight away. It prints where to open the shop and the admin
|
|
21
|
-
`--no-open` to skip that). Ctrl+C stops everything. Nothing is installed globally.
|
|
22
|
-
|
|
23
|
-
## What it does, and why you can trust it
|
|
24
|
-
|
|
25
|
-
- **It runs on your machine only.** Both servers listen on `127.0.0.1`, and the data stays in `~/.shopnex/data`.
|
|
26
|
-
- **It downloads one file.** `create-shopnex` itself fetches only the ShopNex build from this repository's GitHub
|
|
27
|
-
releases, and checks its SHA-256 before it unpacks anything. The checksum comes from the same place as the file, so it
|
|
28
|
-
catches a damaged or half-finished download, not a tampered release: the release itself is what you trust.
|
|
29
|
-
- **The source is here.** The package is
|
|
30
|
-
[`packages/create-shopnex`](https://github.com/shopnex-ai/shopnex/tree/main/packages/create-shopnex) in this
|
|
31
|
-
repository, and has no runtime dependencies: what you run is one bundled file built from that source.
|
|
32
|
-
- **It is built in the open.** Releases and edge builds are published from GitHub Actions
|
|
33
|
-
([release](https://github.com/shopnex-ai/shopnex/blob/main/.github/workflows/release.yaml),
|
|
34
|
-
[edge](https://github.com/shopnex-ai/shopnex/blob/main/.github/workflows/edge.yaml)) with npm provenance, so a
|
|
35
|
-
version's page on npmjs.com shows which commit and workflow run built it. The one exception is `0.0.0-edge.init`, the
|
|
36
|
-
first publish, made by hand to create the package. Publishing uses npm trusted publishing, so there is no long-lived
|
|
37
|
-
npm token.
|
|
11
|
+
runs start straight away. It prints where to open the shop and the admin. Ctrl+C stops everything.
|
|
38
12
|
|
|
39
13
|
## Options
|
|
40
14
|
|
|
@@ -67,7 +41,7 @@ damaged download, not a tampered release.
|
|
|
67
41
|
sessions and stored keys. `SHOPNEX_BUNDLE_URL` downloads from somewhere else (a mirror; the `.sha256` sits next to it)
|
|
68
42
|
and `SHOPNEX_APP_DIR` changes where builds are unpacked.
|
|
69
43
|
|
|
70
|
-
**Edge:** `npx create-shopnex@edge`
|
|
44
|
+
**Edge:** `npx create-shopnex@edge` runs the latest build of `main` (`.github/workflows/edge.yaml` replaces the file of
|
|
71
45
|
the `edge` pre-release on every push). It downloads again only when `main` moved. It can be broken: use a release for
|
|
72
46
|
anything you want to keep.
|
|
73
47
|
|
package/dist/main.mjs
CHANGED
|
@@ -40,7 +40,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
|
|
|
40
40
|
var define_PKG_default;
|
|
41
41
|
var init_define_PKG = __esm({
|
|
42
42
|
"<define:__PKG__>"() {
|
|
43
|
-
define_PKG_default = { version: "0.0.0-edge.
|
|
43
|
+
define_PKG_default = { version: "0.0.0-edge.init", engines: { node: ">=22.22.0" } };
|
|
44
44
|
}
|
|
45
45
|
});
|
|
46
46
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-shopnex",
|
|
3
|
-
"version": "0.0.0-edge.
|
|
3
|
+
"version": "0.0.0-edge.init",
|
|
4
4
|
"description": "Try ShopNex with one command: npx create-shopnex starts the admin and the storefront on an embedded database, nothing else to install",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://shopnex.ai",
|