tarantool / tarantool/tarantool-java-sdk

Create Maven Archetype templates for quick start

Aperta
#70 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Java
Stelle
16
Fork
0
Merge medio
1g 4h
PR unite (30g)
7

Descrizione

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

  1. tarantool-box-quickstart - Template for projects using BOX API (low-level space operations)
  2. tarantool-crud-quickstart - Template for projects using CRUD API (high-level CRUD operations)
  3. tarantool-cluster-quickstart (optional) - Template for clustered Tarantool setups

Reference

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con la guida Maven archetype e l’esempio Flink quickstart, quindi esamina la struttura del repository prima di creare il modulo tarantool-archetypes/. Definisci gli archetipi BOX e CRUD, includendo il relativo codice di esempio, i file README, le dipendenze e la configurazione; il completamento si considera raggiunto quando i progetti generati funzionano e la documentazione include istruzioni per il quickstart.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
build-system, developer-experience, documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
58/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.