proto-spring-cli
v1.0.0
Published
A CLI tool to quickly set up Spring Boot projects with customizable security and database configurations.
Downloads
62
Readme
Spring CLI
A CLI tool to quickly set up Spring Boot projects with customizable security and database configurations.
Features
- Choose between Spring Security and AWS Cognito for authentication
- Select from MySQL, MongoDB, PostgreSQL, or SQL Server for the database
- Automatically generates
Dockerfile
and GitHub Actions for CI/CD - Customizable project details including
groupId
,artifactId
,name
, and more
Prerequisites
- Node.js (>=14.x)
- NPM (>=6.x)
Installation
Install the CLI globally from npm:
npm install -g proto-spring-cli
Usage
To start the CLI, run the following command:
proto-spring-cli
Follow the prompts to configure your Spring Boot project as desired.
Options
The CLI will prompt you for the following options:
- Authentication Choice: Choose between
Spring Security
andAWS Cognito
. - Database Choice: Select a database:
- MySQL
- MongoDB
- PostgreSQL
- SQL Server
- Project Details:
- Group ID: e.g.,
com.example
- Artifact ID: e.g.,
demo
- Project Name: e.g.,
Demo Project
- Project Description: e.g.,
A Spring Boot demo project
- Package Name: e.g.,
com.example.demo
- Java Version: Choose from Java versions 17, 21, or 23.
- Group ID: e.g.,
Generated Project Structure
Once the setup is complete, your project will include:
- A fully configured Spring Boot application.
- Security and database configurations based on your selections.
- A
Dockerfile
for containerizing your application. - GitHub Actions workflows for continuous integration and deployment.
License
This project is licensed under the ISC License.
Contributing
If you have suggestions for improvements or encounter any issues, feel free to submit issues or pull requests. All contributions are welcome!