create-adoniscommerce 2.1.0 → 2.2.0

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.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +93 -0
  3. package/package.json +8 -9
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 AdonisCommerce
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,93 @@
1
+ # create-adoniscommerce
2
+
3
+ Create a new AdonisCommerce e-commerce application with a single command.
4
+
5
+ ## Usage
6
+
7
+ ```bash
8
+ # Using npx (recommended)
9
+ npx create-adoniscommerce my-store
10
+
11
+ # Using pnpm
12
+ pnpm create adoniscommerce my-store
13
+
14
+ # Using yarn
15
+ yarn create adoniscommerce my-store
16
+
17
+ # Using npm
18
+ npm create adoniscommerce my-store
19
+ ```
20
+
21
+ ## Options
22
+
23
+ ```bash
24
+ npx create-adoniscommerce <project-name> [options]
25
+
26
+ Options:
27
+ -t, --template <name> Template to use (default: "default")
28
+ --pm <manager> Package manager (pnpm, npm, yarn, bun)
29
+ --db <type> Database type (postgres, mysql, sqlite)
30
+ --docker Include Docker setup (default: true)
31
+ --git Initialize git repository (default: true)
32
+ --install Install dependencies (default: true)
33
+ -y, --yes Non-interactive mode with defaults
34
+ --dry-run Preview without executing
35
+ -v, --verbose Verbose output
36
+ --offline Use cached template
37
+ -V, --version Output the version number
38
+ -h, --help Display help
39
+ ```
40
+
41
+ ## Examples
42
+
43
+ ```bash
44
+ # Create with Docker support (default)
45
+ npx create-adoniscommerce my-store
46
+
47
+ # Create without Docker
48
+ npx create-adoniscommerce my-store --docker=false
49
+
50
+ # Create without git initialization
51
+ npx create-adoniscommerce my-store --git=false
52
+
53
+ # Create using npm instead of pnpm
54
+ npx create-adoniscommerce my-store --pm npm
55
+
56
+ # Non-interactive mode (use all defaults)
57
+ npx create-adoniscommerce my-store --yes
58
+ ```
59
+
60
+ ## What's Included
61
+
62
+ - Full e-commerce storefront (React + Inertia)
63
+ - Admin panel for store management
64
+ - AdonisJS 7 backend with SOLID architecture
65
+ - PostgreSQL database with 55+ migrations
66
+ - Redis for caching and sessions
67
+ - Docker development environment
68
+ - TypeScript throughout
69
+
70
+ ## After Creation
71
+
72
+ ```bash
73
+ cd my-store
74
+
75
+ # With Docker (recommended)
76
+ make docker-dev
77
+ make docker-db-reset
78
+
79
+ # Without Docker
80
+ pnpm dev
81
+ ```
82
+
83
+ Visit:
84
+ - **App:** http://localhost:3333
85
+ - **Admin:** http://localhost:3333/admin (admin@example.com / admin123)
86
+
87
+ ## Documentation
88
+
89
+ Full documentation: https://github.com/haliltoma/adonisjs-ecommerce-core
90
+
91
+ ## License
92
+
93
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-adoniscommerce",
3
- "version": "2.1.0",
3
+ "version": "2.2.0",
4
4
  "description": "Create a new AdonisCommerce e-commerce application",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -10,13 +10,6 @@
10
10
  "files": [
11
11
  "dist"
12
12
  ],
13
- "scripts": {
14
- "build": "tsup",
15
- "dev": "tsup --watch",
16
- "test": "vitest",
17
- "test:e2e": "vitest run --config vitest.e2e.config.ts",
18
- "prepublishOnly": "pnpm build"
19
- },
20
13
  "keywords": [
21
14
  "adonisjs",
22
15
  "ecommerce",
@@ -56,5 +49,11 @@
56
49
  "tsup": "^8.3.5",
57
50
  "typescript": "^5.8.0",
58
51
  "vitest": "^2.1.8"
52
+ },
53
+ "scripts": {
54
+ "build": "tsup",
55
+ "dev": "tsup --watch",
56
+ "test": "vitest",
57
+ "test:e2e": "vitest run --config vitest.e2e.config.ts"
59
58
  }
60
- }
59
+ }