create-spree-app 0.1.0 → 0.1.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/LICENSE +21 -0
- package/README.md +92 -0
- package/dist/index.js +109 -88
- package/package.json +7 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Vendo Connect Inc., Vendo Sp. z o.o.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# create-spree-app
|
|
2
|
+
|
|
3
|
+
Scaffold a new [Spree](https://spreecommerce.org) project with a single command. Backend runs via Docker using pre-built images
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx create-spree-app my-store
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
This will walk you through an interactive setup:
|
|
12
|
+
|
|
13
|
+
1. Choose **Full-stack** (Backend + Next.js Storefront) or **Backend only**
|
|
14
|
+
2. Optionally load sample data (products, categories, images)
|
|
15
|
+
3. Optionally start Docker services immediately
|
|
16
|
+
|
|
17
|
+
## CLI Flags
|
|
18
|
+
|
|
19
|
+
For non-interactive usage:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx create-spree-app my-store --backend-only --no-sample-data --no-start
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
| Flag | Description |
|
|
26
|
+
|------|-------------|
|
|
27
|
+
| `--backend-only` | Skip storefront setup |
|
|
28
|
+
| `--no-sample-data` | Skip loading sample products |
|
|
29
|
+
| `--no-start` | Don't start Docker services |
|
|
30
|
+
| `--use-npm` | Use npm as package manager |
|
|
31
|
+
| `--use-yarn` | Use yarn as package manager |
|
|
32
|
+
| `--use-pnpm` | Use pnpm as package manager |
|
|
33
|
+
|
|
34
|
+
## What You Get
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
my-store/
|
|
38
|
+
├── docker-compose.yml # Spree backend + Postgres
|
|
39
|
+
├── .env # SECRET_KEY_BASE for Rails
|
|
40
|
+
├── .gitignore
|
|
41
|
+
├── package.json # Convenience scripts (dev, down, logs, etc.)
|
|
42
|
+
├── README.md # Getting started guide
|
|
43
|
+
└── apps/
|
|
44
|
+
└── storefront/ # Next.js app (full-stack mode only)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Prerequisites
|
|
48
|
+
|
|
49
|
+
- [Node.js](https://nodejs.org/) >= 20
|
|
50
|
+
- [Docker](https://docs.docker.com/get-docker/) (for running the backend)
|
|
51
|
+
|
|
52
|
+
## After Setup
|
|
53
|
+
|
|
54
|
+
### Admin Dashboard
|
|
55
|
+
|
|
56
|
+
Open http://localhost:3000/admin
|
|
57
|
+
|
|
58
|
+
- Email: `spree@example.com`
|
|
59
|
+
- Password: `spree123`
|
|
60
|
+
|
|
61
|
+
### Store API
|
|
62
|
+
|
|
63
|
+
http://localhost:3000/api/v3/store
|
|
64
|
+
|
|
65
|
+
### Storefront (full-stack mode)
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
cd my-store/apps/storefront
|
|
69
|
+
npm run dev
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Open http://localhost:3001
|
|
73
|
+
|
|
74
|
+
## Useful Commands
|
|
75
|
+
|
|
76
|
+
Run these from your project directory:
|
|
77
|
+
|
|
78
|
+
| Command | Description |
|
|
79
|
+
|---------|-------------|
|
|
80
|
+
| `npm run dev` | Start backend services |
|
|
81
|
+
| `npm run down` | Stop backend services |
|
|
82
|
+
| `npm run logs` | View backend logs |
|
|
83
|
+
| `npm run console` | Rails console |
|
|
84
|
+
| `npm run load-sample-data` | Load sample products, categories |
|
|
85
|
+
|
|
86
|
+
## Learn More
|
|
87
|
+
|
|
88
|
+
- [Spree Documentation](https://docs.spreecommerce.org)
|
|
89
|
+
|
|
90
|
+
## License
|
|
91
|
+
|
|
92
|
+
MIT
|