# debox

> A dynamic, modular boilerplate manager for NodeJS.

Latest version **1.0.1** (published 2021-02-13) · MIT license · 0 weekly downloads

## Install

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

Provides the command `debox`.

## 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.1 |
| Published | 2021-02-13 |
| First published | 2021-02-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sameera M. |
| Maintainers | sameeramurthy |
| Keywords | boilerplate-generator, templates |

## Links

- npm: https://www.npmjs.com/package/debox
- Repository: https://github.com/SameeraMurthy/debox
- Homepage: https://github.com/SameeraMurthy/debox#readme
- Issues: https://github.com/SameeraMurthy/debox/issues
- npm.io page: https://npm.io/package/debox

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [yargs](https://npm.io/package/yargs.md) ^16.2.0
- [progress](https://npm.io/package/progress.md) ^2.0.3

## Recent versions

- 1.0.1 (latest) — 2021-02-13
- 1.0.0 — 2021-02-13

## README

# Debox
## A dynamic, modular boilerplate manager for NodeJS.

### Installation
In any folder, run:

```
npm install debox -g
```
**-g** is VERY important.

### Usage
Run the `add` command (in the folder you want it to be in) to boil up a template
```
debox add <templateName> <path>
```
`<templateName>`  REQUIRED

`<path>` Optional
> If path is not specified, it creates a `./debox-template/` folder.


### Example
In this example, we will use the template "static-page".
```
debox add static-page
```

Result:
```
myFolder (The folder you ran the command in)
    
    debox-template
        
        index.html
        style.css
        script.js
        assets
```

### Example with path
```
debox add static-page ./
```
> ./ means the current folder.

Result:
```
myFolder (The folder you ran the command in)

    index.html
    style.css
    script.js
    assets
```

### Make your own templates
The feature has been implemented, but the documentation will be coming soon!

### Future Enhancements:
- Much more templates
- Publish your own templates
- Install outside templates with URLs

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