create-modoock-app 1.0.0 → 1.0.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.
Files changed (2) hide show
  1. package/README.md +237 -0
  2. package/package.json +4 -3
package/README.md ADDED
@@ -0,0 +1,237 @@
1
+ # create-modoock-app
2
+
3
+ A production-ready project boilerplate designed to help you start new applications with a consistent architecture, reusable components, design system, and development guidelines.
4
+
5
+ Create a complete project with a single command — the boilerplate and its dependencies are installed automatically.
6
+
7
+ ## Getting Started
8
+
9
+ Create a new project:
10
+
11
+ ```bash
12
+ npx create-modoock-app my-project
13
+ ```
14
+
15
+ Replace `my-project` with the name of your project.
16
+
17
+ Once the installation is complete, move into your project:
18
+
19
+ ```bash
20
+ cd my-project
21
+ ```
22
+
23
+ Start the development server:
24
+
25
+ ```bash
26
+ npm run dev
27
+ ```
28
+
29
+ Your project is now ready for development.
30
+
31
+ ## What's Included
32
+
33
+ The boilerplate comes with a complete development foundation, including:
34
+
35
+ ### UI Components
36
+
37
+ A collection of reusable UI components designed to provide a consistent interface across the application.
38
+
39
+ Includes components such as:
40
+
41
+ - Buttons
42
+ - Inputs
43
+ - Badges
44
+ - Modals
45
+ - Selects
46
+ - Tabs
47
+ - Steppers
48
+ - Loaders
49
+ - Tables
50
+ - Cards
51
+ - Icons
52
+ - Action stacks
53
+ - Timeline lists
54
+ - And more
55
+
56
+ ### Layout System
57
+
58
+ Pre-built layout components for creating consistent application interfaces.
59
+
60
+ Includes:
61
+
62
+ - Application layout
63
+ - Header
64
+ - Side navigation
65
+ - Shared page structures
66
+ - Responsive layout foundations
67
+
68
+ ### Design System
69
+
70
+ A dedicated design system containing:
71
+
72
+ - Typography
73
+ - Spacing
74
+ - Colors
75
+ - Border radius
76
+ - Components
77
+ - UI patterns
78
+ - Design tokens
79
+ - Usage guidelines
80
+
81
+ ### Development Rules
82
+
83
+ The boilerplate includes predefined development rules to help maintain consistent code and UI quality.
84
+
85
+ These cover areas such as:
86
+
87
+ - Architecture
88
+ - Naming conventions
89
+ - Accessibility
90
+ - Responsive design
91
+ - Performance
92
+ - Code quality
93
+ - UI consistency
94
+ - Component reuse
95
+ - Interaction patterns
96
+
97
+ ### AI Development Support
98
+
99
+ The project includes configuration and documentation for AI-assisted development.
100
+
101
+ This includes:
102
+
103
+ - Cursor rules
104
+ - AI agents
105
+ - Development guidelines
106
+ - Component documentation
107
+ - Project knowledge base
108
+ - Reusable implementation patterns
109
+
110
+ The goal is to make AI-assisted development follow the same architecture and design standards as the project.
111
+
112
+ ## Project Structure
113
+
114
+ After running the CLI, your project will contain the complete boilerplate structure:
115
+
116
+ ```text
117
+ my-project/
118
+ ├── app/
119
+ ├── components/
120
+ │ ├── layout/
121
+ │ ├── shared/
122
+ │ └── ui/
123
+ ├── hooks/
124
+ ├── knowledge-base/
125
+ ├── lib/
126
+ ├── providers/
127
+ ├── public/
128
+ ├── types/
129
+ ├── utils/
130
+ ├── .cursor/
131
+ ├── AGENTS.md
132
+ ├── CLAUDE.md
133
+ ├── eslint.config.mjs
134
+ ├── next.config.ts
135
+ ├── package.json
136
+ ├── postcss.config.mjs
137
+ ├── tsconfig.json
138
+ └── ...
139
+ ```
140
+
141
+ ## Technologies
142
+
143
+ The boilerplate is built with:
144
+
145
+ - **Next.js**
146
+ - **React**
147
+ - **TypeScript**
148
+ - **Tailwind CSS**
149
+ - **Lucide React**
150
+ - **ESLint**
151
+
152
+ ## Automatic Installation
153
+
154
+ You don't need to manually install the boilerplate dependencies.
155
+
156
+ Running:
157
+
158
+ ```bash
159
+ npx create-modoock-app my-project
160
+ ```
161
+
162
+ will create the project and install its dependencies automatically.
163
+
164
+ After that, simply run:
165
+
166
+ ```bash
167
+ cd my-project
168
+ npm run dev
169
+ ```
170
+
171
+ ## Project Name
172
+
173
+ The project name is provided directly when running the CLI:
174
+
175
+ ```bash
176
+ npx create-modoock-app my-project
177
+ ```
178
+
179
+ The generated `package.json` will automatically use:
180
+
181
+ ```json
182
+ {
183
+ "name": "my-project"
184
+ }
185
+ ```
186
+
187
+ You can therefore use any valid npm project name.
188
+
189
+ ## Available Scripts
190
+
191
+ Inside your generated project, you can use:
192
+
193
+ ```bash
194
+ npm run dev
195
+ ```
196
+
197
+ Starts the development server.
198
+
199
+ ```bash
200
+ npm run build
201
+ ```
202
+
203
+ Creates a production build.
204
+
205
+ ```bash
206
+ npm run start
207
+ ```
208
+
209
+ Starts the production server.
210
+
211
+ ```bash
212
+ npm run lint
213
+ ```
214
+
215
+ Runs ESLint.
216
+
217
+ ```bash
218
+ npm run typecheck
219
+ ```
220
+
221
+ Checks TypeScript types without generating files.
222
+
223
+ ## Updating create-modoock-app
224
+
225
+ The boilerplate is continuously maintained and updated with improvements, bug fixes, new components, and new development rules.
226
+
227
+ To use the latest published version when creating a new project:
228
+
229
+ ```bash
230
+ npx create-modoock-app@latest my-project
231
+ ```
232
+
233
+ Existing projects are independent after creation, so updates to the boilerplate do not automatically modify previously generated projects.
234
+
235
+ ## License
236
+
237
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-modoock-app",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Project starter and boilerplate generator",
5
5
  "main": "dist/cli.js",
6
6
  "bin": {
@@ -8,7 +8,8 @@
8
8
  },
9
9
  "files": [
10
10
  "dist",
11
- "template"
11
+ "template",
12
+ "README.md"
12
13
  ],
13
14
  "scripts": {
14
15
  "build": "tsc"
@@ -18,4 +19,4 @@
18
19
  "typescript": "^5.0.0"
19
20
  },
20
21
  "license": "MIT"
21
- }
22
+ }