# generate-directory

> Generate the files structure of your project

Latest version **1.0.0-1** (published 2018-07-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install generate-directory
pnpm add generate-directory
yarn add generate-directory
bun add generate-directory
```

Provides the command `generate-directory`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-1 |
| Published | 2018-07-03 |
| First published | 2018-06-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 390.3 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Quentin Jadeau |
| Maintainers | flayert |
| Keywords | generate, structure, setup, cli, boilerplate |

## Links

- npm: https://www.npmjs.com/package/generate-directory
- Repository: https://github.com/jadok/generate-directory
- Homepage: https://github.com/jadok/generate-directory#readme
- Issues: https://github.com/jadok/generate-directory/issues
- npm.io page: https://npm.io/package/generate-directory

## Dependencies (5)

- [ora](https://npm.io/package/ora.md) 2.1.0
- [chalk](https://npm.io/package/chalk.md) 2.4.1
- [core-js](https://npm.io/package/core-js.md) 2.5.7
- [shelljs](https://npm.io/package/shelljs.md) 0.8.2
- [commander](https://npm.io/package/commander.md) 2.16.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

- 1.0.0-1 (latest) — 2018-07-03
- 0.0.1 — 2018-06-29

## README

# generate-directory

A simple nodejs project in typescript to generate the skeleton of your application.

## Installation

```sh
# Locally in your project
npm install -D generate-directory

# Or globally (not recommended)
npm install -g generate-directory
```

**Tip:** Installing modules locally allows you to control and share the versions through `package.json`.

## How it works

The purpose of this project is a skeleton of your new project.
This is done by copying the **.setup-folder** and executing the installation command.

For the moment, the installation process is done only for npm based project but you could use it to install a composer project.

**Tip:** If you intent to do that you just have to extend the [generateDirectory](https://github.com/jadok/generate-directory/tree/master/src/core/generateDirectory.ts) class.

## Executing

### CLI

If you are using it command line, it is expected that you install it globally.

```sh

generate-project new MyApp /path/of/my/skeleton/

```

**Tip:** The third parameter is optional, by default it will look for `process.cwd()`

## Contribution

### Global Dependencies

```sh
npm install -g ts-node typedoc
```

## License

MIT

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