create-dedevs-app

create-dedevs-app

A CLI tool with starters to create a new dev app.

Table of Contents

• System Requirements
• Setup Instructions
• Usage Examples
• Architecture Overview
• Contribution Guidelines

System Requirements

• Node.js v14 or later
• npm or yarn package manager

Setup Instructions

• Clone the repository:

  git clone https://github.com/DeDevsClub/create-dedevs-app.git
  

• Navigate to the project directory:

  cd create-dedevs-app
  

• Install dependencies:

  yarn install
  

  or

  npm install
  

Usage Examples

To create a new project, run the following command and follow the prompts:

node index.js

You can also use the CLI command if installed globally:

create-dedevs-app

Architecture Overview

• index.js: Main entry point for the CLI tool, handles user prompts and project creation.
• starters/: Contains starter templates for different types of projects.
• package.json: Contains project metadata and dependencies.

Contribution Guidelines

• Fork the repository.
• Create a new branch for your feature or bug fix:

  git checkout -b feature-name
  

• Commit your changes:

  git commit -m "Description of changes"
  

• Push to your branch:

  git push origin feature-name
  

• Open a pull request.

Please ensure your code adheres to the project's coding standards and includes appropriate tests.