create-qauri 0.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.
- package/LICENSE +21 -0
- package/README.md +95 -0
- package/dist/index.mjs +744 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +52 -0
- package/templates/base/README.md.tmpl +22 -0
- package/templates/base/gitignore.tmpl +33 -0
- package/templates/config/qauri.config.json.tmpl +31 -0
- package/templates/frontend/react/index.html +12 -0
- package/templates/frontend/react/package.json.tmpl +20 -0
- package/templates/frontend/react/src/App.css +32 -0
- package/templates/frontend/react/src/App.jsx +17 -0
- package/templates/frontend/react/src/main.jsx +10 -0
- package/templates/frontend/react/vite.config.js +10 -0
- package/templates/frontend/react-ts/index.html +12 -0
- package/templates/frontend/react-ts/package.json.tmpl +23 -0
- package/templates/frontend/react-ts/src/App.css +32 -0
- package/templates/frontend/react-ts/src/App.tsx +17 -0
- package/templates/frontend/react-ts/src/main.tsx +10 -0
- package/templates/frontend/react-ts/tsconfig.json +15 -0
- package/templates/frontend/react-ts/vite.config.ts +10 -0
- package/templates/frontend/svelte/index.html +12 -0
- package/templates/frontend/svelte/package.json.tmpl +19 -0
- package/templates/frontend/svelte/src/App.svelte +46 -0
- package/templates/frontend/svelte/src/main.js +7 -0
- package/templates/frontend/svelte/vite.config.js +10 -0
- package/templates/frontend/svelte-ts/index.html +12 -0
- package/templates/frontend/svelte-ts/package.json.tmpl +22 -0
- package/templates/frontend/svelte-ts/src/App.svelte +46 -0
- package/templates/frontend/svelte-ts/src/main.ts +7 -0
- package/templates/frontend/svelte-ts/svelte.config.js +5 -0
- package/templates/frontend/svelte-ts/tsconfig.json +14 -0
- package/templates/frontend/svelte-ts/vite.config.ts +10 -0
- package/templates/frontend/vanilla/index.html +16 -0
- package/templates/frontend/vanilla/main.js +6 -0
- package/templates/frontend/vanilla/package.json.tmpl +17 -0
- package/templates/frontend/vanilla/style.css +25 -0
- package/templates/frontend/vanilla-ts/index.html +13 -0
- package/templates/frontend/vanilla-ts/main.ts +8 -0
- package/templates/frontend/vanilla-ts/package.json.tmpl +18 -0
- package/templates/frontend/vanilla-ts/style.css +25 -0
- package/templates/frontend/vanilla-ts/tsconfig.json +14 -0
- package/templates/frontend/vanilla-ts/vite.config.ts +8 -0
- package/templates/frontend/vue/index.html +12 -0
- package/templates/frontend/vue/package.json.tmpl +19 -0
- package/templates/frontend/vue/src/App.vue +48 -0
- package/templates/frontend/vue/src/main.js +4 -0
- package/templates/frontend/vue/vite.config.js +10 -0
- package/templates/frontend/vue-ts/index.html +12 -0
- package/templates/frontend/vue-ts/package.json.tmpl +21 -0
- package/templates/frontend/vue-ts/src/App.vue +48 -0
- package/templates/frontend/vue-ts/src/main.ts +4 -0
- package/templates/frontend/vue-ts/tsconfig.json +15 -0
- package/templates/frontend/vue-ts/vite.config.ts +10 -0
- package/templates/native/cpp/CMakeLists.txt.tmpl +16 -0
- package/templates/native/cpp/main.cpp.tmpl +24 -0
- package/templates/native/python/main.py.tmpl +19 -0
- package/templates/native/python/pyproject.toml.tmpl +8 -0
- package/templates/native/python/requirements.txt.tmpl +2 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Qauri Team
|
|
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,95 @@
|
|
|
1
|
+
# create-qauri
|
|
2
|
+
|
|
3
|
+
Scaffolding tool for creating [Qauri](https://github.com/popo-studio/qauri-web-component) projects with interactive prompts.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# npm
|
|
9
|
+
npm create qauri@latest
|
|
10
|
+
|
|
11
|
+
# pnpm
|
|
12
|
+
pnpm create qauri
|
|
13
|
+
|
|
14
|
+
# yarn
|
|
15
|
+
yarn create qauri
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Optionally specify a project name:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm create qauri@latest my-app
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## What it does
|
|
25
|
+
|
|
26
|
+
The CLI walks you through an interactive wizard to configure your project:
|
|
27
|
+
|
|
28
|
+
1. **Project name** — validates naming conventions
|
|
29
|
+
2. **Native language** — C++ or Python
|
|
30
|
+
3. **Python configuration** (if Python selected):
|
|
31
|
+
- Package manager (pip or uv)
|
|
32
|
+
- Python version (3.9-3.12)
|
|
33
|
+
- Python path detection
|
|
34
|
+
4. **Qt configuration**:
|
|
35
|
+
- Qt version (6.5.3, 6.9.2)
|
|
36
|
+
- Qt path detection
|
|
37
|
+
5. **Backend** — WebView2 (Windows), CEF (cross-platform), or Both
|
|
38
|
+
6. **Frontend framework** — Vanilla, React, Vue, or Svelte (with TypeScript variants)
|
|
39
|
+
7. **Features** — DevTools (F12), Reload (F5), Command Whitelist, Examples
|
|
40
|
+
8. **New window behavior** — Block, Browser, or New Window
|
|
41
|
+
9. **Install dependencies** — Automatically run npm install
|
|
42
|
+
|
|
43
|
+
Then generates a complete project structure ready for development.
|
|
44
|
+
|
|
45
|
+
## Generated Project Structure
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
my-qauri-app/
|
|
49
|
+
├── index.html
|
|
50
|
+
├── package.json
|
|
51
|
+
├── vite.config.js
|
|
52
|
+
├── src/ # Frontend source
|
|
53
|
+
│ └── ...
|
|
54
|
+
├── src-qauri/ # Native code
|
|
55
|
+
│ ├── qauri.config.json
|
|
56
|
+
│ ├── main.cpp / main.py
|
|
57
|
+
│ └── CMakeLists.txt # (C++ only)
|
|
58
|
+
├── .gitignore
|
|
59
|
+
└── README.md
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Supported Templates
|
|
63
|
+
|
|
64
|
+
### Frontend Frameworks
|
|
65
|
+
- Vanilla / Vanilla + TypeScript
|
|
66
|
+
- React / React + TypeScript
|
|
67
|
+
- Vue / Vue + TypeScript
|
|
68
|
+
- Svelte / Svelte + TypeScript
|
|
69
|
+
|
|
70
|
+
All templates use Vite as the build tool and include `@qauri/api` for JS↔Native communication.
|
|
71
|
+
|
|
72
|
+
### Native Languages
|
|
73
|
+
- **C++** — CMake project linking Qt6 and qauri
|
|
74
|
+
- **Python** — PySide6 + pyqauri, with uv or pip environment setup
|
|
75
|
+
|
|
76
|
+
## Development
|
|
77
|
+
|
|
78
|
+
For development on the Qauri project itself, use [`qauri-cli`](https://github.com/popo-studio/qauri-cli):
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
npm install -g qauri-cli
|
|
82
|
+
qauri dev
|
|
83
|
+
qauri build
|
|
84
|
+
qauri info
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## License
|
|
88
|
+
|
|
89
|
+
MIT
|
|
90
|
+
|
|
91
|
+
## Links
|
|
92
|
+
|
|
93
|
+
- [Qauri Web Component](https://github.com/popo-studio/qauri-web-component)
|
|
94
|
+
- [Qauri CLI](https://github.com/popo-studio/qauri-cli)
|
|
95
|
+
- [Qauri JS SDK](https://github.com/popo-studio/qauri-js-sdk)
|