# starter-generator

> Uma ferramenta poderosa para inicializar rapidamente projetos Node.js, React.js, React Native e mais. Escolha seu design pattern, tipo de projeto e comece a codificar em segundos.

Latest version **1.0.0** (published 2023-12-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install starter-generator
pnpm add starter-generator
yarn add starter-generator
bun add starter-generator
```

Provides the command `starter-generator`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-12-06 |
| First published | 2023-12-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 59.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Xarlys Souza e Daiane Bittencourt |
| Maintainers | xarlysouza |
| Keywords | node, react, react-native, typescript, project, init, boilerplate |

## Links

- npm: https://www.npmjs.com/package/starter-generator
- npm.io page: https://npm.io/package/starter-generator

## Dependencies (5)

- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.6
- [@swc/core](https://npm.io/package/@swc/core.md) ^1.3.100
- [typescript](https://npm.io/package/typescript.md) ^5.3.2
- [@inquirer/prompts](https://npm.io/package/@inquirer/prompts.md) ^3.3.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-12-06

## README

## 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:

```bash
npm install -g starter-generator
```

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

```bash
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

```bash
npx starter-generator
```

Create a ReactJS project without TypeScript and MVVM design pattern

```bash
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](https://github.com/xarlys)
* **A passionate developer** - [Daiane](https://github.com/daianebittencourt)

⌨️ with ❤️ by [Xarlys Souza](https://github.com/xarlys) 😊
⌨️ with ❤️ by [Daiane bittencourt](https://github.com/bittencourt) 😊

---
_Source: https://npm.io/package/starter-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._