create-zen 1.0.2 → 1.0.4
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 +75 -0
- package/index.js +2 -2
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# create-zen
|
|
2
|
+
|
|
3
|
+
✨ Create a new web development project with modern setup powered by Vite 🚀
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm create-zen my-app
|
|
9
|
+
cd my-app
|
|
10
|
+
npm install
|
|
11
|
+
npm run dev
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Features
|
|
15
|
+
|
|
16
|
+
- 🚀 **Lightning Fast** - Powered by Vite for instant hot module replacement
|
|
17
|
+
- 🎨 **Modern UI** - Beautiful and responsive design out of the box
|
|
18
|
+
- 📱 **Mobile First** - Optimized for all devices
|
|
19
|
+
- 🔧 **Developer Friendly** - Hot reload, TypeScript support, and more
|
|
20
|
+
- 📦 **Zero Config** - Get started immediately without complex setup
|
|
21
|
+
|
|
22
|
+
## What's Included
|
|
23
|
+
|
|
24
|
+
- **Vite** - Next generation frontend tooling
|
|
25
|
+
- **Modern CSS** - Tailwind CSS for rapid UI development
|
|
26
|
+
- **TypeScript** - Type safety and better developer experience
|
|
27
|
+
- **ESLint & Prettier** - Code quality and formatting
|
|
28
|
+
- **Git Hooks** - Pre-commit linting and formatting
|
|
29
|
+
|
|
30
|
+
## Getting Started
|
|
31
|
+
|
|
32
|
+
1. **Create a new project:**
|
|
33
|
+
```bash
|
|
34
|
+
npm create-zen my-awesome-app
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
2. **Navigate to your project:**
|
|
38
|
+
```bash
|
|
39
|
+
cd my-awesome-app
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
3. **Install dependencies:**
|
|
43
|
+
```bash
|
|
44
|
+
npm install
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
4. **Start development server:**
|
|
48
|
+
```bash
|
|
49
|
+
npm run dev
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
5. **Open your browser** and visit `http://localhost:5173`
|
|
53
|
+
|
|
54
|
+
## Available Scripts
|
|
55
|
+
|
|
56
|
+
- `npm run dev` - Start development server
|
|
57
|
+
- `npm run build` - Build for production
|
|
58
|
+
- `npm run preview` - Preview production build
|
|
59
|
+
- `npm run lint` - Run ESLint
|
|
60
|
+
- `npm run format` - Format code with Prettier
|
|
61
|
+
|
|
62
|
+
## Project Structure
|
|
63
|
+
|
|
64
|
+
```
|
|
65
|
+
my-app/
|
|
66
|
+
├── public/
|
|
67
|
+
├── src/
|
|
68
|
+
│ ├── components/
|
|
69
|
+
│ ├── styles/
|
|
70
|
+
│ └── main.ts
|
|
71
|
+
├── index.html
|
|
72
|
+
├── package.json
|
|
73
|
+
├── tsconfig.json
|
|
74
|
+
├── vite.config.ts
|
|
75
|
+
```
|
package/index.js
CHANGED
|
@@ -37,8 +37,8 @@ console.log();
|
|
|
37
37
|
console.log('👉', cyan('Next steps:'));
|
|
38
38
|
console.log();
|
|
39
39
|
console.log(` 📁 ${yellow('cd ' + PROJECT_NAME)}`);
|
|
40
|
-
console.log(' 📦', yellow('
|
|
41
|
-
console.log(' 🧑💻', yellow('
|
|
40
|
+
console.log(' 📦', yellow('npm install'));
|
|
41
|
+
console.log(' 🧑💻', yellow('npm run dev'));
|
|
42
42
|
console.log();
|
|
43
43
|
console.log('🌿 Happy coding!');
|
|
44
44
|
console.log();
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-zen",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "✨ Create a new project
|
|
3
|
+
"version": "1.0.4",
|
|
4
|
+
"description": "✨ Create a new web development project with modern setup powered by Vite 🚀",
|
|
5
5
|
"bin": {
|
|
6
6
|
"create-zen": "./index.js"
|
|
7
7
|
},
|