# endor-cli

> Come to the javascript side 🚀 🌑

Latest version **1.0.9** (published 2020-08-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install endor-cli
pnpm add endor-cli
yarn add endor-cli
bun add endor-cli
```

Provides the command `endor-cli`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.9 |
| Published | 2020-08-25 |
| First published | 2020-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 17.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | stanleygomes |
| Maintainers | stanleygomesdasilva |

## Links

- npm: https://www.npmjs.com/package/endor-cli
- Repository: https://github.com/stanleygomes/endor-cli
- Issues: https://github.com/stanleygomes/endor-cli
- npm.io page: https://npm.io/package/endor-cli

## Dependencies (8)

- [i18n](https://npm.io/package/i18n.md) ^0.8.3
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [figlet](https://npm.io/package/figlet.md) ^1.5.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.4
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
- [commander](https://npm.io/package/commander.md) ^6.0.0

## Recent versions

- 1.0.9 (latest) — 2020-08-25
- 1.0.8 — 2020-08-25
- 1.0.7 — 2020-08-22
- 1.0.6 — 2020-08-22
- 1.0.5 — 2020-08-22
- 1.0.4 — 2020-08-22
- 1.0.3 — 2020-08-22
- 1.0.2 — 2020-08-22
- 1.0.1-rc.1 — 2020-08-22
- 1.0.1 — 2020-08-22
- 1.0.0 — 2020-08-22

## README

[![CodeFactor](https://www.codefactor.io/repository/github/stanleygomes/endor-cli/badge)](https://www.codefactor.io/repository/github/stanleygomes/endor-cli)
![Lint and test](https://github.com/stanleygomes/endor-cli/workflows/Lint%20and%20test/badge.svg)

# Endor CLI

A Javascript Boilerplate Generator CLI. Come to javascript side 🚀 🌑

The main goal of **Endor CLI** is to make it easy to start a javascript project using great and minimal boilerplates.

*******
Table of contents
 1. [How to use](#startup)
 2. [Available Boilerplates](#boilerplates)
 3. [Patterns and libs](#patterns)
 4. [Contribute](#contribute)
 5. [Gitflow recommendations](#gitflow)
*******

<div id='startup'/>

## How to use

First time you'll need to install the package from npm globally

```
npm i -g endor-cli
```

Now you're ready to rock and create your first app

```
endor-cli create
```

<div id='boilerplates'/>

## Available Boilerplates

These are the available boilerplates to get your project started

- Nodejs: [nodevader](https://github.com/stanleygomes/nodevader)
- React: [juggernaut](https://github.com/SoftboxLab/juggernaut)

<div id='patterns'/>

## Patterns

These are some of patterns definitions to help us to keep a default arquitecture

- Package manager: [npm](https://medium.com/@vincentnewkirk/npm-vs-yarn-2019-e88757b17038), sure
- Node version: [v10.x](https://nodejs.org/ca/blog/release/v10.16.3)
- Linter: eslint [standard](https://standardjs.com) pattern
- i18n: take a look [here](https://www.npmjs.com/package/i18n)
- Date and time: [moment](https://momentjs.com)
- Test: [Mocha](https://mochajs.org) & [Chai](https://www.chaijs.com)
- Logs: use [Winston](https://www.npmjs.com/package/winston)

<div id='contribute'/>

## How to get contribute

Step by step to get this up and running

**Clone repo and go to project folder**

```
git clone https://github.com/stanleygomes/endor-cli.git && cd endor-cli
```

**Install dependencies**

```bash
npm install
```

**Config enviroment**

Copy enviroment variables template

```bash
cp .env.template .env
```

**Start**

```bash
npm start
```

<div id='gitflow'/>

## Git flow

To file a new a feature

- create a branch from `master` branch. Use the pattern: `feature/description`
- file a pull request on `master` branch
- since your PR is aproved, it will be merged to `master` branch
- in a moment in time we'll create a release, using the pattern: `release/vX.X.X`

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