@inglorious / create-app
的官方脚手架工具来快速创建一个新的web应用程序 @inglorious /网络 框架或预呈现的站点,静态或服务器呈现 @inglorious / ssx.
这个包允许你从一组预配置的模板中生成一个新项目,所以你可以马上开始开发你的web应用程序。
使用
要创建一个新应用,在终端中运行以下命令之一。系统将提示您选择一个项目名称并选择一个模板。
# with npm
npm create @inglorious/app@latest
# with yarn
yarn create @inglorious/app
# with pnpm
pnpm create @inglorious/app
CLI将引导您完成设置过程,询问您想要使用的项目名称和模板。
对于JavaScript和TypeScript Vite模板,CLI会询问应用的特性:
| 问题 | 国旗 | 增加了 |
|---|---|---|
| 使用不美观的UI? | --ui / --no-ui | @inglorious/ui,它的基本样式和一个应用栏 |
| 哪个主题? | --theme=inglorious|material-ui|material-3|bootstrap|ios-18|ios-26 | 主题的样式表和类 |
| 它是一个移动应用程序吗? | --mobile / --no-mobile | Android和iOS平台的《电容器》;不美观的用户界面,底部标签栏和安全区域间隔 |
| 添加路由? | --routing / --no-routing | 路由器,一个主页和一个关于页面,以及它们之间的导航 |
| 动画页面转换? | --transitions / --no-transitions | 查看页面之间的转换(使用路由和不美观的UI) |
| 哪个图标包? | --icons=material,fontawesome,lucide / --no-icons | 图标化图标集,由不光彩的UI绘制 Icon (UI不美观) |
| 翻译应用程序? | --i18n / --no-i18n, --languages=en,it | @inglorious/i18n每种语言的目录和语言选择器;第一种语言是默认的 |
| 添加分析? | --analytics / --no-analytics | 谷歌分析Firebase背后的同意提示,在网络和本地应用程序 |
| 添加推送通知? | --push / --no-push | Firebase云消息,一个权限提示和Supabase端发送;打开PWA支持 |
| 启用PWA支持? | --pwa / --no-pwa | vite-plugin-pwa一个清单、图标和一个service worker,它将已安装的应用保持在最新版本 |
每个模板 minimal 然后询问是否添加座席技能(--skills / --no-skills). 说“是” 技能CLI 在新项目中。它询问要安装哪个编码代理,并安装 锻造技能 符合你的选择: forge, forge-best-practices, store, web 和 web-best-practices 总是,加上 ssx, vite-plugin-jsx 或者 vite-plugin-vue, ui 和 ui-best-practices, i18n, firebase 和 supabase 当项目使用它们时。如果安装失败,CLI会打印命令重新安装。
应用程序以您选择的语法生成:lit-html、JSX或Vue。在命令行上回答的每个问题都会被跳过,因此可以在没有任何提示的情况下创建项目:
| 问题 | 参数或标志 |
|---|---|
| 你的项目叫什么名字? | 第一个参数,如 my-app |
| 选择模板 | --template=minimal|js|ts|ssx-js|ssx-ts |
| 选择呈现语法 | --syntax=lit-html|jsx|vue |
npm create @inglorious/app@latest -- my-app --template=ts --syntax=jsx --ui --theme=material-3 --routing --transitions --icons=material --languages=en,it --no-mobile --no-analytics --no-push --no-pwa --skills
分析和推送将其设置步骤生成到新项目的README中 .env.example。Push还生成一个Supabase迁移,即 push-notify Edge函数和service worker:推送是通过插入一行来发送的 notifications。它需要一个Firebase项目、一个Supabase项目和一个登录屏幕,因为一旦有人使用Supabase Auth登录,就会出现权限提示。
模板
下面的模板可以帮助你开始:
- 最小的一个最小的入门模板,不需要捆绑:只有HTML, CSS和JS。
- js:一个纯JavaScript项目的入门模板,与Vite捆绑在一起。
- ts:一个纯TypeScript项目的入门模板,与Vite捆绑在一起。
- ssx-js:一个使用JavaScript的静态站点执行(SSX)项目的初始模板。
- ssx-ts一个使用TypeScript的静态站点执行(SSX)项目的初始模板。
它是做什么的
该工具将用您选择的项目名称创建一个新目录,并将模板文件复制到其中。它还会自动更新 package.json 使用项目名称。
创建项目后,您可以导航到该目录并安装依赖项。
# 1. Change into your new project directory
cd my-awesome-app
# 2. Install dependencies
pnpm install
# 3. Start the development server
pnpm dev
当启用移动支持时,初始化原生平台一次,然后构建并同步它们:
# Run one or both commands once, depending on the platforms you need
pnpm mobile:init:android
pnpm mobile:init:ios
pnpm mobile:sync
# Build and open the native app
pnpm mobile:android
# or
pnpm mobile:ios
对于Android和iOS版本,安装带有Android SDK的Android Studio和与电容器兼容的Java运行时。电容器目前可以可靠地与JDK 21一起工作,所以如果遇到Java兼容性问题,请选择JDK 21而不是较新的Java版本。集 JAVA_HOME 到JDK 21安装并安装 ANDROID_HOME 在运行本机应用程序之前,请查看官方的电容器设置指南,了解特定平台的说明:
- Android: https://capacitorjs.com/docs/android
- iOS: https://capacitorjs.com/docs/ios
- Android工作室: https://developer.android.com/studio
许可证
麻省理工学院许可证-免费和开源
您可以自由地使用、修改和分发本软件。看到 许可证 获取详细信息。