Skip to content

punixcorn/spring-tui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Spring Initializr Logo

spring-tui

Terminal UI for generating Spring Boot projects using Spring Initializr
Explore Spring Initializr

View Repo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

spring-tui is a terminal UI that lets you configure and generate Spring Boot projects using Spring Initializr. It provides a fast keyboard driven workflow for selecting options and dependencies, and can export a config file for later reuse.

(back to top)

Built With

(back to top)

Getting Started

Follow these steps to build and run the app locally.

Prerequisites

Installation

  1. Clone the repo
    git clone https://github.com/punixcorn/spring-tui.git
  2. Build
    cargo build
  3. Run the TUI
    cargo run

(back to top)

Usage

Run from a config file:

./target/debug/spring-tui --file config.yaml

Config formats supported: YAML, JSON, TOML.

Example files:

TUI controls:

Keybinding Action
Tab switches between Config and Dependencies panes
Up and Down navigate items
Enter selects or edits the current field
Shift + c opens configuration menu

(back to top)

Roadmap

  • TUI configuration workflow
  • Dependency search and selection
  • Export configuration file
  • Config import from TUI
  • Project extraction after download
  • Default config for most settings at ~/.config
  • Ui improvments

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are welcome.

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/my-change)
  3. Commit your changes (git commit -m "Add feature")
  4. Push to the branch (git push origin feature/my-change)
  5. Open a pull request

Please keep changes focused and include relevant screenshots for UI changes.

(back to top)

License

Distributed under the Apache License 2.0. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/punixcorn/spring-tui

(back to top)

Acknowledgments

(back to top)

About

A tui for spring initializr

Resources

License

Stars

Watchers

Forks

Packages

No packages published