Git Product home page Git Product logo

eg-dev-setup's Introduction

eg-dev-setup

A Node.js command-line interface (CLI) tool that automates the creation of predefined project structures for web development.

image

Features

  • Quick Setup: Initialize React and NestJS projects with predefined templates.
  • Modular Design: Core functionalities like CLI handling, file operations, and logging are separated into different modules for better maintainability.
  • Custom Logger: Utilizes a custom logger setup for clear and structured logging.

Installation

To create a new project, simply run:

npx eg-dev-setup

or install eg-dev-setup globally using npm:

npm install -g eg-dev-setup

This allows you to use eg-dev-setup from anywhere on your system.

Usage

To create a new project, simply run:

eg-dev-setup

You will be prompted to choose the type of project you want to set up:

  • React Project
  • NestJS Project

Select your desired project type, and eg-dev-setup will automatically create the project structure in your current directory.

Project Structure

The CLI tool is structured as follows:

eg-dev-setup/
│
├── bin/                  # Entry point scripts
│   └── eg-dev-setup.js      # Main executable
│
├── lib/                  # Core functionality
│   ├── cli.js            # Setup CLI commands and options
│   ├── copier.js         # Handles copying of templates
│   └── logger.js         # Logger configuration
│
├── templates/            # Project templates directory
│   ├── react/            # React project template
│   └── nest/             # NestJS project template
│
├── package.json          # Node package file
└── README.md             # Project README

Contributing

Contributions are welcome! If you have suggestions or improvements, please fork the repository and submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

eg-dev-setup's People

Contributors

egmzy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.