Create Maven Archetype templates for quick start
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 58/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- java
调研方向
先阅读 Maven archetype 指南和 Flink quickstart 示例,然后在创建 tarantool-archetypes/ 模块之前检查仓库结构。定义 BOX 和 CRUD archetype,包括示例代码、README 文件、依赖项和配置;生成的项目能够正常工作,并且文档包含 quickstart 说明,即表示完成。
由索引模型根据 Issue 内容生成。
描述
Summary
Create Maven Archetype templates to enable quick project scaffolding for common Tarantool Java SDK use cases, similar to Flink's quickstart archetype.
Motivation
Currently, users need to manually set up their project structure and dependencies when starting with Tarantool Java SDK. Providing archetype templates would significantly improve the developer experience by generating ready-to-use project skeletons.
Desired Usage
# BOX API quickstart
mvn archetype:generate \
-DarchetypeGroupId=io.tarantool \
-DarchetypeArtifactId=tarantool-box-quickstart \
-DarchetypeVersion=1.6.0
# CRUD API quickstart
mvn archetype:generate \
-DarchetypeGroupId=io.tarantool \
-DarchetypeArtifactId=tarantool-crud-quickstart \
-DarchetypeVersion=1.6.0
Proposed Archetypes
- tarantool-box-quickstart - Template for projects using BOX API (low-level space operations)
- tarantool-crud-quickstart - Template for projects using CRUD API (high-level CRUD operations)
- tarantool-cluster-quickstart (optional) - Template for clustered Tarantool setups
Reference
- Maven Guide: https://maven.apache.org/guides/mini/guide-creating-archetypes.html
- Flink example: https://github.com/apache/flink/tree/master/flink-quickstart
Acceptance Criteria
- Archetype module structure created under
tarantool-archetypes/ - BOX API archetype with sample code and README
- CRUD API archetype with sample code and README
- Generated projects include proper dependencies and configuration
- Documentation updated with quickstart instructions
- 主要语言
- Java
- 星标
- 16
- 派生
- 0
- 平均合并
- 1 天 4 小时
- 30 天内合并 PR
- 7
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
tarantool/tarantool-java-sdk 的其他 Issue
-
documentation
tarantool/tarantool-java-sdk#56 · 已指派 1 人 ·
-
documentation
tarantool/tarantool-java-sdk#49 · 已指派 1 人 ·
查看 tarantool/tarantool-java-sdk 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 76/100
-
bug needs triage
难度 2/5 1-3 小时 新手友好度 76/100
-
难度 1/5 1 小时以内 新手友好度 94/100
objectionary/hone-maven-plugin#1061 ·
-
type:bug
难度 2/5 1-3 小时 新手友好度 72/100