tarantool / tarantool/tarantool-java-sdk
Create Maven Archetype templates for quick start
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 16
- Forks
- 0
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 7
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Maven archetype guide and the Flink quickstart example, then inspect the repository structure before creating the tarantool-archetypes/ module. Define the BOX and CRUD archetypes, including their sample code, README files, dependencies, and configuration; completion means generated projects work and the documentation includes quickstart instructions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100