starter-generator

🚀 Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Descrição

starter-generator is a command-line tool (CLI) that helps create Node.js project structures with different design patterns and TypeScript options.

📋 Pré-requisites

[Yarn] ou [Npm] - (https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)

Make sure you have Node.js installed. You can install the CLI globally using the following command:

npm install -g starter-generator

How to Use

Once installed globally, you can use the following command to create a new project:

npx starter-generator

The CLI will guide you to choose the project name, project type (NodeJS, ReactJS, React Native), whether to use TypeScript, and the desired design pattern (MVC, MVVM, Observer, SOLID, etc.).

Available Options

projectName: Project name. authorName: Author name. projectType: Project type (NodeJS, ReactJS, React Native). useTypeScript: Whether to use TypeScript (true/false). designPattern: Design pattern (MVC, MVVM, Observer, SOLID, etc.).

Exemplos

Create a Node.js project with TypeScript and MVC design pattern

npx starter-generator

Create a ReactJS project without TypeScript and MVVM design pattern

npx create-pattern-project-nodejs --projectType "ReactJS" --useTypeScript false --designPattern "MVVM"

Contribuindo

If you find bugs or want to contribute in any way, feel free to open an issue or submit a pull request.

🛠️ Construído com

• JavaScript | Typescript
• EsLint
• Prettier
• TSup
• Jest (Teste)

✒️ Authors

• A passionate developer - Xarlys
• A passionate developer - Daiane

⌨️ with ❤️ by Xarlys Souza 😊 ⌨️ with ❤️ by Daiane bittencourt 😊