# pozoljs

> Initialize a node-express project with typescript or javascript and create full components to develop your backend apps faster.

Latest version **0.8.4** (published 2021-10-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install pozoljs
pnpm add pozoljs
yarn add pozoljs
bun add pozoljs
```

Provides the command `pozoljs`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.4 |
| Published | 2021-10-19 |
| First published | 2020-11-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 132.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Carolina Morales, |
| Maintainers | carolina-morales |
| Keywords | cli, create-pozol-project, pozoljs, pozol js, pozol, pozol-app |

## Links

- npm: https://www.npmjs.com/package/pozoljs
- Repository: https://github.com/carolina-morales/pozoljs
- Homepage: https://github.com/carolina-morales/pozoljs#readme
- Issues: https://github.com/carolina-morales/pozoljs/issues
- npm.io page: https://npm.io/package/pozoljs

## Dependencies (10)

- [ejs](https://npm.io/package/ejs.md) ^3.1.5
- [ncp](https://npm.io/package/ncp.md) ^2.0.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [execa](https://npm.io/package/execa.md) ^4.0.3
- [listr](https://npm.io/package/listr.md) ^0.14.3
- [figlet](https://npm.io/package/figlet.md) ^1.5.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3
- [commander](https://npm.io/package/commander.md) ^6.1.0
- [copyfiles](https://npm.io/package/copyfiles.md) ^2.3.0
- [cli-table3](https://npm.io/package/cli-table3.md) ^0.6.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.8.4 (latest) — 2021-10-19
- 0.8.3 — 2021-08-03
- 0.8.2 — 2021-08-03
- 0.8.1 — 2021-06-07
- 0.8.0 — 2021-05-13
- 0.7.1 — 2021-04-27
- 0.7.0 — 2021-04-26
- 0.6.4 — 2021-01-17
- 0.6.3 — 2021-01-17
- 0.6.2 — 2020-11-23
- 0.6.1 — 2020-11-18

## README

# Pozol CLI

Pozoljs is a package to initialize your node-express project with typescript or javascript and create full components to develop your backend apps faster.

Pozoljs will helps you to get a node-express project more escalable with a good estructure for folders and files.

Pozoljs is not a framework.

## Getting start

- [Installing](#installing)
- [The CLI](#the-cli)
  - [Some concepts](#some-concepts)
  - [Build your project](#build-project)
  - [Files structure](#files-structure)
- [Commands](#commands)
  - [Schematics available](#schematic-available)
- [About the project](#about-project)

## Installing the CLI <a name="installing"></a>

Global installation.
```shell
npm install -g pozoljs
yarn global add pozoljs
```

Local installation.
```shell
npm install pozoljs
yarn add pozoljs
```

When the package is installed, you will can use `pozoljs` command.

## The CLI :book: <a name="the-cli"></a>

### Some concepts <a name="some-concepts"></a>

1. **Component** is a small folder that contains the principal modules of an endpoint. For example, you will develop endpoints about users, so in the users folder you will have controller, service, routes files (and interface if it is a typescript project).
2. **Service** connect with the database or return data that you need. In other words, the service provides data to the controller. In the start, the service file implements find, save, update and delete methods.
3. **Controller** manipulate the data that obtains of the service or of the route. The controller call service methods through dependency injection.
4. **Routes** about your component like GET, POST, PUT or DELETE.
5. **Interface** is using in typescript like a data type.

### Build your project using pozoljs <a name="build-project"></a>

Create a new node-express projects with an initial structure. <br>
*`pozoljs new <name> [options]`*

#### Options available
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Alias</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>--skip-install</td>
      <td>-i</td>
      <td>If you do not to install initial dependencies.</td>
    </tr>
    <tr>
      <td>--skip-git</td>
      <td>-g</td>
      <td>If you do not to initialize for git repositorie.</td>
    </tr>
    <tr>
      <td>--language</td>
      <td>-l</td>
      <td>Typescript is the default language. You can choose javascript. Just type javascript, js, typescript or ts.</td>
    </tr>
    <tr>
      <td>--directory</td>
      <td></td>
      <td>Destination directory. Must be a relative path.</td>
    </tr>
    <tr>
      <td>--yarn</td>
      <td></td>
      <td>Use yarn instead npm.</td>
    </tr>
    <tr>
      <td>--help</td>
      <td></td>
      <td>For more information.</td>
    </tr>
  </tbody>
</table>

### Files Structure <a name="files-structure"></a>

Pozoljs builds a node-express project with an initial structure. This one helps you to develop faster and escalable code. The initial structure is: <br>
```shell
├────src
│    ├───api
│    │   └───component
│    │   │    ├───component.controller.ts/js
│    │   │    ├───component.interface.ts
│    │   │    ├───component.routes.ts/js
│    │   │    └───component.service.ts/js
│    │   └───index.ts/js
│    ├───global
│    │   ├───helpers
│    │   │    └───abstract.api-routes.ts
│    │   │    └───abstract.routes.ts
│    │   │    └───abstract.service.ts
│    │   ├───config.ts/js
│    │   ├───interfaces.ts
│    │   └───utils.ts/js
│    │   └───variables.ts/js
│    ├───middlewares
│    ├───database.ts/js
│    ├───index.ts/js
│    └───server.ts/js
├───.editorconfig
├───.env
├───.env.example
├───.gitignore
├───package.json
├───pozoljs.config.json
├───package-lock.json/yarn.lock
└───tsconfig.json
```

## Schematics <a name="commands"></a>

All commands have the full type and abreviation type. <br>
*`pozoljs g <schematic> [name]`*

### Schematics availables <a name="#schematic-available"></a>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Alias</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>component</td>
      <td>cp</td>
      <td>Create controller, service, routes and interface file in the api folder by default.</td>
    </tr>
    <tr>
      <td>controller</td>
      <td>ct</td>
      <td>Create controller file and create the folder if does not exists.</td>
    </tr>
    <tr>
      <td>service</td>
      <td>sv</td>
      <td>Create service file and create the folder if does not exists.</td>
    </tr>
    <tr>
      <td>routes</td>
      <td>rt</td>
      <td>Create controller file and create the folder if does not exists.</td>
    </tr>
    <tr>
      <td>interface</td>
      <td>ic</td>
      <td>Create interface file and create the folder if does not exists.</td>
    </tr>
  </tbody>
</table>

## About the project created <a name="about-project"></a>

The project created using pozoljs is to get an initial and generic structure of all your node projects.

In the package.json there are 3 commands:

1. Run `npm run dev`/`yarn dev` to execute the project in development mode.
2. Run `npm run build`/`yarn build` to create the production project (just for typescript).
3. Run `npm run start`/`yarn start` to execute the project in the production mode.

For more information, you can execute: `pozoljs --help`

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