@propeller-commerce/create-propeller-shop 0.5.0 → 0.5.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 +57 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# @propeller-commerce/create-propeller-shop
|
|
2
|
+
|
|
3
|
+
Scaffold a new [Propeller Commerce](https://propellercommerce.com) shop in
|
|
4
|
+
minutes: pick a stack, pick a mode, pick a CMS, answer a few prompts, and get
|
|
5
|
+
a working storefront wired to the Propeller GraphQL backend.
|
|
6
|
+
|
|
7
|
+
## Quick start
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx @propeller-commerce/create-propeller-shop@latest my-shop \
|
|
11
|
+
--stack=next \
|
|
12
|
+
--mode=hybrid \
|
|
13
|
+
--cms=strapi
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
> Published under the scoped name `@propeller-commerce/create-propeller-shop`,
|
|
17
|
+
> so the `npx` invocation must include the scope. The executable it installs is
|
|
18
|
+
> still `create-propeller-shop`.
|
|
19
|
+
|
|
20
|
+
Pick another stack:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx @propeller-commerce/create-propeller-shop@latest my-vue-shop --stack=vue --mode=hybrid
|
|
24
|
+
npx @propeller-commerce/create-propeller-shop@latest my-nuxt-shop --stack=nuxt --mode=hybrid
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Then:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
cd my-shop/frontend
|
|
31
|
+
cp .env.local.example .env.local # .env.example / .env for vue + nuxt
|
|
32
|
+
npm install
|
|
33
|
+
npm run dev
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Stacks
|
|
37
|
+
|
|
38
|
+
| `--stack` | Framework |
|
|
39
|
+
|---|---|
|
|
40
|
+
| `next` | Next 16 + React |
|
|
41
|
+
| `vue` | Vue 3 + Vite SSR |
|
|
42
|
+
| `nuxt` | Nuxt 3 SSR |
|
|
43
|
+
|
|
44
|
+
## Modes
|
|
45
|
+
|
|
46
|
+
| `--mode` | Account routes | Portal default | Register form |
|
|
47
|
+
|---|---|---|---|
|
|
48
|
+
| `b2b` | + quotes, authorization, contacts | `semi-closed` | Contact only |
|
|
49
|
+
| `b2c` | universal only | `open` | Customer only |
|
|
50
|
+
| `hybrid` | + quotes, authorization, contacts (gated at runtime) | `open` | Both |
|
|
51
|
+
|
|
52
|
+
Run `npx @propeller-commerce/create-propeller-shop --help` for the full flag
|
|
53
|
+
list, or omit flags to be prompted interactively.
|
|
54
|
+
|
|
55
|
+
## License
|
|
56
|
+
|
|
57
|
+
MIT
|