YG Project Generator

YG Project Generator is a CLI tool (Command Line Interface) designed to facilitate the setup of Node.js projects. This tool automatically generates the foundational structure of a project, including a pre-configured server.js file, environment variable setups, database configuration, and Swagger documentation. It is geared towards providing a quick and efficient method to establish the initial codebase and documentation necessary for a robust Node.js application.

Features

• Automatic Project Structure Generation: Creates a comprehensive directory structure tailored for Node.js applications.
• Server.js Configuration: Automatically generates a server.js file configured with Express.js.
• Environment Variable Setup: Initializes environment variable configurations suitable for development and production environments.
• Database Configuration: Supports initial setups for databases like MySQL, PostgreSQL, and MongoDB.
• Swagger Documentation: Automatically generates Swagger API documentation to kickstart your API design and testing.

Prerequisites

Ensure you have Node.js and npm installed on your system. You can verify your installation with the following commands:

node --version
npm --version

Installation

To set up ProjectName on your system install the package with:

npm install yg-project-generator

Or if you want to use the generator for multiple projects, you should install the package globally with :

npm install yg-project-generator -g

Usage

Generate a New Project

After installation, generate your new project structure by running if you have the package installed globally:

generate-project

or if you have the package installed locally:

npx generate-project

Follow the on-screen prompts to customize your project's initial setup according to your requirements.

You can also use the command line arguments to skip the prompts and generate the projects.

Configuration

Further customization and configuration can be done by modifying the generated files and settings according to the project's needs.

Contribution

Contributions are welcome! If you'd like to contribute, please fork the repository, create a feature branch, and submit pull requests for review. For any questions or suggestions, please open an issue in the repository.

Authors

• @Lemalty

License

This project is licensed under the MIT License.