# root-up

> generator for template folder by boilerplate

Latest version **2.0.8** (published 2023-02-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install root-up
pnpm add root-up
yarn add root-up
bun add root-up
```

Provides the command `root-up`.

## 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 | 2.0.8 |
| Published | 2023-02-27 |
| First published | 2023-02-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | minsoo-web |
| Maintainers | minsoo-web |
| Keywords | boilerplate, template generate, folder generate, template, template folder auto generate |

## Links

- npm: https://www.npmjs.com/package/root-up
- Repository: https://github.com/minsoo-web/root-up
- Issues: https://github.com/minsoo-web/root-up/issues
- npm.io page: https://npm.io/package/root-up

## Dependencies (1)

- [inquirer](https://npm.io/package/inquirer.md) ^9.1.4

## Recent versions

- 2.0.8 (latest) — 2023-02-27
- 2.0.7 — 2023-02-14
- 2.0.6 — 2023-02-13
- 2.0.5 — 2023-02-13
- 2.0.4 — 2023-02-13
- 2.0.3 — 2023-02-13
- 2.0.2 — 2023-02-13
- 2.0.1 — 2023-02-13
- 2.0.0 — 2023-02-13

## README

# Root Up

![banner](./src/assets/images/banner.png)

English | [한국어](https://github.com/minsoo-web/root-up/blob/main/README.ko.md)

## Table of contents

- [🗂 What is Root Up?](#-what-is-root-up)
- [🚗 Installation](#-installation)
  - [Global](#global)
  - [Local](#local)
- [🛑 Before you start](#-before-you-start)
  - [templateFolder](#templateFolder)
  - [config.json](#config.json)
- [🚀 How to run](#-how-to-run)
- [🚕 Demo](#-demo)
- [Contributing](#contributing)

## 🗂 What is Root Up?

This package is built for folder structure generator who has specific folder template.

## 🚗 Installation

### Global

```bash
# using yarn
yarn global add root-up
```

```bash
# using npm
npm install -g root-up
```

### Local

```bash
# using yarn
yarn add -D root-up
```

```bash
# using npm
npm install -D root-up
```

> Note: add --save if you are using npm < 5.0.0

Add script in your `package.json`

```json
"scripts": {
   "root-up": "root-up"
},
```

## 🛑 Before you start

You must make `.template` folder to your root path in workspace
The `.template` folder must be configured as follows

```txt
/.template
   /<templateFolder>
   /<templateFolder>
   ...
   config.json
```

[Checkout `.template` folder demo](https://github.com/minsoo-web/root-up/tree/main/.template)

### templateFolder

`/<templateFolder>` ... is your own template.
Make sure check prefix in your config.json

### config.json

The `.config.json` file must be configured as follows

```json
{
  "prefix": "YOUR_FAVORITE_PREFIX",
  "output": "YOUR_DEFAULT_OUTPUT_PATH_IN_YOUR_WORKSPACE",
  "excludePath": ["YOUR_IGNORE_PREFIX"]
}
```

**prefix**:
The `prefix` property is the property that sets the alternate text to be replaced by the name of the folder.  
Write down the name of the file, the code used in the template.

**output**:
The `output` property is the property that path to template folder generated _related path_ to your command is executed path

**excludePath**:  
The `excludePath` property is the property that can ignore path finding in searching path to generate folder (e.g: .yarn folder)  
Default is `node_modules` and `.git`

## 🚀 How to run

```bash
# Global installed
root-up

# or local installed
yarn <command> # specified in your package.json
```

## 🚕 Demo

> You can use npx

https://user-images.githubusercontent.com/57122180/218425678-eabb9b8d-f7a2-4048-bec1-e32f2da900b0.mov

## Contributing

We welcome contribution from everyone in the community.

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