jhipster/svelte-hipster

Svelte Hipster

概述

Svelte Hipster 是一个 JHipster 蓝图，旨在将 SvelteKit / Svelte 作为客户端开发框架，用于生成现代化的Web应用。

新增功能

每个版本的详细更新内容请参考 变更日志。

支持的流程和集成

开发中

以下集成已支持：

• ✅ 会话、JWT、OIDC认证
• ✅ 深色模式支持
• ✅ SvelteKit、Vite集成
• ✅ Tailwind CSS
• ✅ Prettier、EsLint集成
• ✅ Cypress端到端测试集成
• ✅ Jest和Testing Library单元测试集成
• ✅ JHipster应用JDL
• ✅ JHipster实体JDL（简单数据类型，无关联）
• ✅ JHipster Elasticsearch集成

以下功能流程已通过端到端测试覆盖：

• ✅ 登录
• ✅ 注册
• ✅ 忘记密码
• ✅ 首页
• ✅ 账户
  • ✅ 修改密码
  • ✅ 设置
  • ✅ 登出
• ✅ 管理
  • ✅ 用户管理（列表、创建、更新、查看、删除）
  • ✅ 日志
• ✅ 实体
  • ✅ 实体（列表、查看、删除、搜索、分页）

更多详情可查看 https://github.com/jhipster/jhipster-sample-app-svelte 源代码。

技术栈

安装

安装蓝图

执行以下命令安装蓝图：

bash
npm install -g generator-jhipster-svelte

更新蓝图

执行以下命令更新蓝图：

bash
npm update -g generator-jhipster-svelte

使用方法

交互式生成应用

Svelte Hipster 蓝图提供 cli 以使用正确版本的 JHipster。执行以下命令交互式生成新应用：

bash
shipster

通过JDL配置生成应用

也可使用应用JDL生成新应用（配置方式）。参考 JDL应用 文档了解所有支持的选项。

创建如下应用JDL并保存为文件（示例中为 app.jdl）：

application {
    config {
        baseName SampleBlogApp,
        applicationType monolith,
        authenticationType session,
        packageName tech.jhipster.samples.blog,
        prodDatabaseType postgresql,
        cacheProvider caffeine,
        buildTool maven
    }
    entities *
}

entity Blog {
    name String required minlength(3)
    handle String required minlength(2)
}

entity Tag {
    name String required minlength(3)
}

paginate Tag with pagination

通过 shipster cli 传递 import-jdl 选项及文件路径生成应用：

bash
shipster import-jdl app.jdl

通过JHipster命令生成

若已在工作站安装 JHipster，可执行以下命令（覆盖使用全局JHipster版本）。注意使用兼容的 Svelte Hipster 和 JHipster 版本：

bash
jhipster --blueprints svelte

JHipster兼容性矩阵

Docker开发

Svelte Hipster Docker镜像可在 https://hub.docker.com/r/jhipster/svelte-hipster 获取。

拉取镜像

拉取最新发布版本

sh
docker pull jhipster/svelte-hipster

拉取最新开发版本（未发布）

sh
docker pull jhipster/svelte-hipster:main

生成应用

创建应用目录并执行以下命令生成应用：

sh
mkdir svelte-app && cd svelte-app

docker run -it --rm -v $PWD:/app jhipster/svelte-hipster

运行生成的应用

以下示例假设使用 maven 作为构建工具：

运行单元测试

sh
docker run -it --rm -v $PWD:/app -v ~/.m2:/home/shipster/.m2 --entrypoint ./mvnw jhipster/svelte-hipster clean test

启动应用（默认dev配置）

sh
docker run -it --rm -v $PWD:/app -v ~/.m2:/home/shipster/.m2 -p 8080:8080 --entrypoint ./mvnw jhipster/svelte-hipster -DskipTests

通过 http://localhost:8080/ 访问应用。

访问容器文件系统

可通过以下命令附加 Bourne shell 访问容器文件系统：

sh
docker run -it --rm -v $PWD:/app -v ~/.m2:/home/shipster/.m2 --entrypoint sh jhipster/svelte-hipster

本地开发

鼓励提交拉取请求，欢迎参与开发。

设置开发环境步骤如下：

1. 全局链接Svelte蓝图：

bash
cd generator-jhipster-svelte
npm link

2. 链接JHipster开发版本到蓝图（可选：仅在使用非发布版JHipster时需要，如main分支或自定义分支）：

bash
cd generator-jhipster
npm link

cd generator-jhipster-svelte
npm link generator-jhipster

3. 创建应用目录并链接JHipster和Svelte蓝图：

bash
mkdir my-app && cd my-app

npm link generator-jhipster-svelte
npm link generator-jhipster (可选：仅在使用非发布版JHipster时需要)

shipster

许可证

Apache-2.0 © Vishal Mahajan