create-zephyr-apps 0.0.49 → 0.0.51
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 +103 -3
- package/dist/package.json +1 -1
- package/dist/templates.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,107 @@
|
|
|
5
5
|
[Zephyr Cloud](https://zephyr-cloud.io) | [Zephyr Docs](https://docs.zephyr-cloud.io) | [Discord](https://zephyr-cloud.io/discord) | [Twitter](https://x.com/ZephyrCloudIO) | [LinkedIn](https://www.linkedin.com/company/zephyr-cloud/)
|
|
6
6
|
|
|
7
7
|
<hr/>
|
|
8
|
+
<img src="https://cdn.prod.website-files.com/669061ee3adb95b628c3acda/66981c766e352fe1f57191e2_Opengraph-zephyr.png" alt="Zephyr Logo" />
|
|
9
|
+
</div>
|
|
8
10
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
11
|
+
A CLI tool to create web applications using Zephyr. This package provides templates and scaffolding for quickly setting up new projects with Zephyr integration.
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# npm (global)
|
|
17
|
+
npm install -g create-zephyr-apps
|
|
18
|
+
|
|
19
|
+
# npx (recommended)
|
|
20
|
+
npx create-zephyr-apps@latest
|
|
21
|
+
|
|
22
|
+
# yarn
|
|
23
|
+
yarn create zephyr-apps
|
|
24
|
+
|
|
25
|
+
# pnpm
|
|
26
|
+
pnpm create zephyr-apps
|
|
27
|
+
|
|
28
|
+
# bun
|
|
29
|
+
bunx create-zephyr-apps
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Usage
|
|
33
|
+
|
|
34
|
+
### Interactive Mode
|
|
35
|
+
|
|
36
|
+
Run the command without arguments to start the interactive mode:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npx create-zephyr-apps@latest
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
This will prompt you to choose:
|
|
43
|
+
|
|
44
|
+
- Project name
|
|
45
|
+
- Template type (React, Vue, etc.)
|
|
46
|
+
- Build tool (Vite, Webpack, Rspack, etc.)
|
|
47
|
+
- Additional configurations
|
|
48
|
+
|
|
49
|
+
### Direct Usage
|
|
50
|
+
|
|
51
|
+
You can also specify options directly:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npx create-zephyr-apps@latest my-app --template vite-react
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Available Templates
|
|
58
|
+
|
|
59
|
+
- **vite-react** - React application with Vite
|
|
60
|
+
- **vite-react-mf** - React microfrontend with Vite and Module Federation
|
|
61
|
+
- **rspack-react** - React application with Rspack
|
|
62
|
+
- **rspack-mf** - React microfrontend with Rspack and Module Federation
|
|
63
|
+
- **webpack-react** - React application with Webpack
|
|
64
|
+
- **modern-js** - Modern.js application
|
|
65
|
+
- **repack-react-native** - React Native application with Re.Pack
|
|
66
|
+
- **rollup-lib** - Library with Rollup
|
|
67
|
+
- **parcel-react** - React application with Parcel
|
|
68
|
+
|
|
69
|
+
## Getting Started
|
|
70
|
+
|
|
71
|
+
After creating your application:
|
|
72
|
+
|
|
73
|
+
1. Navigate to your project directory:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
cd my-app
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
2. Install dependencies:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
npm install
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
3. Start the development server:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
npm run dev
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
4. Build for production:
|
|
92
|
+
```bash
|
|
93
|
+
npm run build
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Features
|
|
97
|
+
|
|
98
|
+
- 🚀 Quick project scaffolding
|
|
99
|
+
- 📦 Multiple bundler support (Vite, Webpack, Rspack, Parcel)
|
|
100
|
+
- 🔧 Pre-configured Zephyr integration
|
|
101
|
+
- 🏗️ Module Federation ready templates
|
|
102
|
+
- 📱 React Native support with Re.Pack
|
|
103
|
+
- 🎯 TypeScript support out of the box
|
|
104
|
+
|
|
105
|
+
## Contributing
|
|
106
|
+
|
|
107
|
+
We welcome contributions! Please read our [contributing guidelines](../../CONTRIBUTING.md) for more information.
|
|
108
|
+
|
|
109
|
+
## License
|
|
110
|
+
|
|
111
|
+
Licensed under the Apache-2.0 License. See [LICENSE](LICENSE) for more information.
|
package/dist/package.json
CHANGED
package/dist/templates.js
CHANGED
|
@@ -38,7 +38,7 @@ export const Templates = [
|
|
|
38
38
|
hint: 'You will be building federated React apps powered by Vite, Webpack and Rspack.',
|
|
39
39
|
},
|
|
40
40
|
{
|
|
41
|
-
name: 'react-
|
|
41
|
+
name: 'vite-react-ts',
|
|
42
42
|
label: 'A simple React application build by Vite',
|
|
43
43
|
hint: 'You will be building React app powered by Vite.',
|
|
44
44
|
},
|