UNPKG

spring-boot-cli-generator

Version:

CLI tool for generating boilerplate code for Spring Boot applications.

60 lines (35 loc) 2.07 kB
# NGOS Spring File Generator CLI The NGOS Spring File Generator CLI is a command-line tool designed to help you quickly generate boilerplate code for Spring Boot applications. With this tool, you can easily create Spring Boot Controllers and Services by providing essential information. ## Table of Contents - [Installation](#installation) - [Usage](#usage) - [Features](#features) - [Getting Started](#getting-started) - [Contributing](#contributing) - [License](#license) ## Installation You need to have Node.js and npm (Node Package Manager) installed on your system to use this CLI tool. If you don't have them, you can download and install them from the official [Node.js website](https://nodejs.org/). To install the NGOS Spring File Generator CLI, open your terminal and run the following command: ```bash npm i -g spring-boot-cli-generator ``` ## Usage To run the NGOS Spring File Generator CLI, open your terminal and type: ```bash spring ``` Follow the on-screen prompts to generate Spring Boot files. ## Features - Generate Spring Boot Controllers and Services with ease. - Interactive prompts for gathering essential information. - Customizable generated file names and content. ## Getting Started 1. Install the NGOS Spring File Generator CLI as described in the [Installation](#installation) section. 2. Run the CLI tool using the command `spring`. 3. Follow the interactive prompts to generate Spring Boot Controllers and Services. Provide information such as module name, entity name, and service SO name. 4. The CLI tool will generate the necessary boilerplate code based on your inputs. You will find the generated files in your current working directory. 5. Enjoy the saved time and effort in creating Spring Boot files! ## Contributing Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue on the [GitHub repository](https://github.com/mazlanmohdnor/spring-cli). Pull requests are also encouraged. ## License This project is licensed under the [MIT License](LICENSE).